gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-22 16:33:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Various documentation fixes

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14690 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2002-10-09 11:30:37 +00:00
parent 03aa2b3917
commit e598375a3c
6 changed files with 65 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -4,6 +4,10 @@
* Tools/GNUmakefile: build autogsdoc documentation automatically
if possible.
* Tools/AGSOutput.m: Make automatic cross references for functions.
* Source/Docmakefile: Use handcrafted template files. Document the
path utilities file.
* Documentation/Functions.gsdoc: Handcrafted template.
* Documentation/TypesAndConstants.gsdoc: Handcrafted template.
2002-10-08 Richard Frith-Macdonald <rfm@gnu.org>

21
Documentation/Functions.gsdoc Normal file
View file

@ -0,0 +1,21 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
<gsdoc base="Functions" up="Base">
<head>
<title>Functions</title>
<author name="Richard Frith-Macdonald"></author>
</head>
<body>
<front>
<contents />
<chapter>
<heading>Function index</heading>
<index type="function" scope="file" />
</chapter>
<chapter>
<heading>Macro index</heading>
<index type="macro" scope="file" />
</chapter>
</front>
</body>
</gsdoc>

25
Documentation/TypesAndConstants.gsdoc Normal file
View file

@ -0,0 +1,25 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
<gsdoc base="TypesAndConstants" up="Base">
<head>
<title>Types and Constants</title>
<author name="Richard Frith-Macdonald"></author>
</head>
<body>
<front>
<contents />
<chapter>
<heading>Type index</heading>
<index type="type" scope="file" />
</chapter>
<chapter>
<heading>Variable index</heading>
<index type="variable" scope="file" />
</chapter>
<chapter>
<heading>Constant index</heading>
<index type="constant" scope="file" />
</chapter>
</front>
</body>
</gsdoc>

2
Headers/gnustep/base/NSPathUtilities.h
View file

@ -29,7 +29,7 @@
#include <Foundation/NSString.h>
#ifndef NO_GNUSTEP
/*
/**
* This extension permits a change of username from that specified in the
* LOGNAME environment variable. Using it will almost certainly cause
* trouble if the process does not posess the file access priviliges of the

15
Source/DocMakefile
View file

@ -76,6 +76,7 @@ NSNull.h \
NSNumberFormatter.h \
NSObjCRuntime.h \
NSObject.h \
NSPathUtilities.h \
NSPort.h \
NSPortCoder.h \
NSPortMessage.h \
@ -132,10 +133,20 @@ include $(GNUSTEP_MAKEFILES)/documentation.make
# directory, and temporarily copy the base source file here for autogsdoc
# to use.
#
before-all::
$(MKDIRS) ../Documentation/Base
before-all:: ../Documentation/Base \
../Documentation/Base/Functions.gsdoc \
../Documentation/Base/TypesAndConstants.gsdoc
cp ../Documentation/Base.gsdoc .
../Documentation/Base:
$(MKDIRS) ../Documentation/Base
../Documentation/Base/Functions.gsdoc: ../Documentation/Functions.gsdoc
cp ../Documentation/Functions.gsdoc ../Documentation/Base
../Documentation/Base/TypesAndConstants.gsdoc: ../Documentation/TypesAndConstants.gsdoc
cp ../Documentation/TypesAndConstants.gsdoc ../Documentation/Base
#
# Clean up temporary files used while generating documentation.
#

2
Source/NSHashTable.m
View file

@ -242,7 +242,7 @@ NSEndHashTableEnumeration(NSHashEnumerator *enumerator)
/**
* Return an enumerator for stepping through a map table using the
* NSNextHashEnumeratorPair() function.
* NSNextHashEnumeratorItem() function.
*/
NSHashEnumerator
NSEnumerateHashTable(NSHashTable *table)