mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 16:33:29 +00:00
more doc tweaks
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@37669 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
rfm
parent
86707832fb
commit
3ce3aefd23
8 changed files with 93 additions and 79 deletions
|
|
@ -509,6 +509,7 @@ notice and this notice are preserved.
|
|||
mechanism is to use the 'Local Time Zone' value from the
|
||||
user defaults system.
|
||||
</p>
|
||||
</desc>
|
||||
|
||||
<term>USERPROFILE</term>
|
||||
<desc>
|
||||
|
|
|
|||
|
|
@ -38,6 +38,7 @@ notice and this notice are preserved.
|
|||
to add the latest version of OSX.<br />
|
||||
The release has various platform/portability tweaks, as
|
||||
well as a variety of bugfixes.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
|
|
@ -55,6 +56,7 @@ notice and this notice are preserved.
|
|||
to correct issues (mostly with NSInteger/NSUInteger on 64bit systems)
|
||||
with printf formats in various debug/logging messages.<br />
|
||||
Timezone data was updated for this release.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
|
|
|
|||
|
|
@ -273,14 +273,16 @@ GS_EXPORT NSString * const NSStreamSOCKSProxyVersionKey;
|
|||
#if OS_API_VERSION(MAC_OS_X_VERSION_10_7,GS_API_LATEST) && GS_PROTOCOLS_HAVE_OPTIONAL
|
||||
@protocol NSStreamDelegate <NSObject>
|
||||
@optional
|
||||
- (void) stream: (NSStream*)sStream handleEvent: (NSStreamEvent)anEvent;
|
||||
@end
|
||||
#else
|
||||
/**
|
||||
* Informal protocol for delegates of instance of the [NSStream] class.
|
||||
*/
|
||||
@interface NSObject (NSStreamDelegate)
|
||||
#endif
|
||||
- (void) stream: (NSStream*)sStream handleEvent: (NSStreamEvent)anEvent;
|
||||
@end
|
||||
#endif
|
||||
|
||||
#if defined(__cplusplus)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -185,36 +185,8 @@ Base_AGSDOC_FLAGS = \
|
|||
-TypedefsTemplate TypesAndConstants \
|
||||
-VariablesTemplate TypesAndConstants \
|
||||
-WordMap '{\
|
||||
DEFINE_BLOCK_TYPE="//";\
|
||||
FOUNDATION_EXPORT=extern;\
|
||||
FOUNDATION_STATIC_INLINE="";\
|
||||
GS_ATTRIB_DEPRECATED="";\
|
||||
GS_DECLARE="";\
|
||||
GS_DEPRECATED_FUNC="";\
|
||||
GS_EXPORT=extern;\
|
||||
GS_GC_STRONG="";\
|
||||
GS_GEOM_ATTR="";\
|
||||
GS_GEOM_SCOPE=extern;\
|
||||
GS_NORETURN_METHOD="";\
|
||||
GS_PRIVATE_INTERNAL="//";\
|
||||
GS_RANGE_ATTR="";\
|
||||
GS_RANGE_SCOPE=extern;\
|
||||
GS_ROOT_CLASS="";\
|
||||
GS_STATIC_INLINE="";\
|
||||
GS_UNUSED_ARG="";\
|
||||
GS_UNUSED_FUNC="";\
|
||||
GS_UNUSED_IVAR="";\
|
||||
GS_ZONE_ATTR="";\
|
||||
GS_ZONE_SCOPE=extern;\
|
||||
INLINE=inline;\
|
||||
NS_AUTOMATED_REFCOUNT_UNAVAILABLE="";\
|
||||
NS_CONSUMED="";\
|
||||
NS_CONSUMES_SELF="";\
|
||||
NS_RETURNS_NOT_RETAINED="";\
|
||||
NS_RETURNS_RETAINED="";\
|
||||
WINAPI="";\
|
||||
__strong="";\
|
||||
__weak="";\
|
||||
}' -Up Base
|
||||
|
||||
BaseAdditions_AGSDOC_FLAGS = \
|
||||
|
|
@ -230,27 +202,7 @@ BaseAdditions_AGSDOC_FLAGS = \
|
|||
-TypedefsTemplate TypesAndConstants \
|
||||
-VariablesTemplate TypesAndConstants \
|
||||
-WordMap '{\
|
||||
DEFINE_BLOCK_TYPE="//";\
|
||||
FOUNDATION_EXPORT=extern;\
|
||||
FOUNDATION_STATIC_INLINE="";\
|
||||
GS_ATTRIB_DEPRECATED="";\
|
||||
GS_DECLARE="";\
|
||||
GS_EXPORT=extern;\
|
||||
GS_GEOM_ATTR="";\
|
||||
GS_GEOM_SCOPE=extern;\
|
||||
GS_NORETURN_METHOD="";\
|
||||
GS_PRIVATE_INTERNAL="//";\
|
||||
GS_RANGE_ATTR="";\
|
||||
GS_RANGE_SCOPE=extern;\
|
||||
GS_STATIC_INLINE="";\
|
||||
GS_UNUSED_IVAR="";\
|
||||
GS_ZONE_ATTR="";\
|
||||
GS_ZONE_SCOPE=extern;\
|
||||
INLINE=inline;\
|
||||
NS_CONSUMED="";\
|
||||
NS_CONSUMES_SELF="";\
|
||||
NS_RETURNS_NOT_RETAINED="";\
|
||||
NS_RETURNS_RETAINED="";\
|
||||
WINAPI="";\
|
||||
}' -Up BaseAdditions
|
||||
|
||||
|
|
|
|||
|
|
@ -66,35 +66,7 @@ BaseTools_AGSDOC_FLAGS = \
|
|||
-HeaderDirectory ../Tools \
|
||||
-Standards YES \
|
||||
-WordMap '{\
|
||||
FOUNDATION_EXPORT=extern;\
|
||||
FOUNDATION_STATIC_INLINE="";\
|
||||
GS_ATTRIB_DEPRECATED="";\
|
||||
GS_DECLARE="";\
|
||||
GS_DEPRECATED_FUNC="";\
|
||||
GS_EXPORT=extern;\
|
||||
GS_GC_STRONG="";\
|
||||
GS_GEOM_ATTR="";\
|
||||
GS_GEOM_SCOPE=extern;\
|
||||
GS_NORETURN_METHOD="";\
|
||||
GS_PRIVATE_INTERNAL="//";\
|
||||
GS_RANGE_ATTR="";\
|
||||
GS_RANGE_SCOPE=extern;\
|
||||
GS_ROOT_CLASS="";\
|
||||
GS_STATIC_INLINE="";\
|
||||
GS_UNUSED_ARG="";\
|
||||
GS_UNUSED_FUNC="";\
|
||||
GS_UNUSED_IVAR="";\
|
||||
GS_ZONE_ATTR="";\
|
||||
GS_ZONE_SCOPE=extern;\
|
||||
INLINE=inline;\
|
||||
NS_AUTOMATED_REFCOUNT_UNAVAILABLE="";\
|
||||
NS_CONSUMED="";\
|
||||
NS_CONSUMES_SELF="";\
|
||||
NS_RETURNS_NOT_RETAINED="";\
|
||||
NS_RETURNS_RETAINED="";\
|
||||
WINAPI="";\
|
||||
__strong="";\
|
||||
__weak="";\
|
||||
}' -Up BaseTools
|
||||
|
||||
# Use local version of autogsdoc in case it is not installed
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ DTD_FILES = plist-0_9.dtd \
|
|||
|
||||
# Manual pages to install
|
||||
MAN1_PAGES = gdnc.1 autogsdoc.1 cvtenc.1 defaults.1 gspath.1 \
|
||||
pldes.1 sfparse.1 xmlparse.1
|
||||
pldes.1 sfparse.1 xmlparse.1 HTMLLinker.1
|
||||
MAN7_PAGES = gsdoc.7
|
||||
MAN8_PAGES = gdomap.8
|
||||
|
||||
|
|
|
|||
85
Tools/HTMLLinker.1
Normal file
85
Tools/HTMLLinker.1
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
.TH HTMLLinker 1 "August 16, 2009" "GNUstep" "GNUstep System Manual"
|
||||
|
||||
.SH NAME
|
||||
HTMLLinker \- tool to fix up href references in HTML files
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B HTMLLinker
|
||||
.RI [ options ]
|
||||
.I input files
|
||||
[
|
||||
.B -l
|
||||
.I relocation file
|
||||
]
|
||||
[
|
||||
.B -d
|
||||
.I destination file
|
||||
]
|
||||
.br
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B HTMLLinker
|
||||
is a tool to fix href references in HTML files, typically API
|
||||
reference manuals generated by extracting the docstrings from source
|
||||
code by tools such as
|
||||
.BR autogsdoc (1).
|
||||
.PP
|
||||
.B HTMLLinker
|
||||
accepts the following options (multiple
|
||||
.I input files\fR,\fR
|
||||
.I -l
|
||||
and
|
||||
.I -d
|
||||
options are allowed):
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B --help
|
||||
Prints a short list of available options.
|
||||
.TP
|
||||
.B --version
|
||||
Displays version information.
|
||||
.TP
|
||||
.B --verbose
|
||||
Prints additional information while processing.
|
||||
.TP
|
||||
.BI -Warn " [YES|NO]"
|
||||
Print additional information about unresolved links.
|
||||
.TP
|
||||
.BI -LinksMarker " [xxx]"
|
||||
Only fix links with attribute \fBrel\f\=\fIxxx\fR
|
||||
.TP
|
||||
.B -FixupAllLinks YES
|
||||
Attempt to fix all links (not only those that are marked with
|
||||
\fI-LinksMarker\fR.
|
||||
.TP
|
||||
.B -PathMappingsFile \fIfile\fR
|
||||
Read the relocation mappings from
|
||||
.I file
|
||||
(in dictionary format).
|
||||
.TP
|
||||
.B -PathMappings '{"\fIpath\fR\fB"="\fR\fIanother_path\fR\fB";}'\fR
|
||||
Use the specified path mappings.
|
||||
.TP
|
||||
.BI -BuildRelocationFileForDir " dir"
|
||||
Build a relocation file for the directory
|
||||
.I dir
|
||||
and save it into \fIdir\fR/table.htmlink. This option is special and
|
||||
prevents any other processing by the linker.
|
||||
|
||||
.SH SEE ALSO
|
||||
.BR autogsdoc (1),
|
||||
.BR GNUstep (7).
|
||||
|
||||
.SH AUTHORS
|
||||
.B HTMLLinker
|
||||
was written by Nicola Pero <nicola@brainstorm.co.uk>.
|
||||
.P
|
||||
This manual page was added by Yavor Doganov <yavor@gnu.org>.
|
||||
|
||||
.SH COPYRIGHT
|
||||
Copyright (C) 2009 Free Software Foundation, Inc.
|
||||
.P
|
||||
Copying and distribution of this file, with or without modification,
|
||||
are permitted in any medium without royalty provided the copyright
|
||||
notice and this notice are preserved.
|
||||
|
|
@ -1278,7 +1278,7 @@ main(int argc, char **argv, char **env)
|
|||
[wm setObject: @"" forKey: @"GS_RANGE_ATTR"];
|
||||
[wm setObject: @"extern" forKey: @"GS_RANGE_SCOPE"];
|
||||
[wm setObject: @"" forKey: @"GS_ROOT_CLASS"];
|
||||
[wm setObject: @"static inline" forKey: @"GS_STATIC_INLINE"];
|
||||
[wm setObject: @"static" forKey: @"GS_STATIC_INLINE"];
|
||||
[wm setObject: @"" forKey: @"GS_UNUSED_ARG"];
|
||||
[wm setObject: @"" forKey: @"GS_UNUSED_FUNC"];
|
||||
[wm setObject: @"" forKey: @"GS_UNUSED_IVAR"];
|
||||
|
|
|
|||
Loading…
Reference in a new issue