Tweak the property list docs a little.

This commit is contained in:
Bill Currie 2011-08-20 19:23:31 +09:00
parent 1402feafd2
commit 6268bd2965
3 changed files with 4 additions and 4 deletions

View file

@ -4,7 +4,7 @@ SUBDIRS= man
DOX=\ DOX=\
bind.dox connect.dox cshifts.dox dirconf.dox faq.dox \ bind.dox connect.dox cshifts.dox dirconf.dox faq.dox \
filesystem.dox mapformat.dox property-lists.dox qtv.dox quakeforge.dox \ filesystem.dox mapformat.dox property-list.dox qtv.dox quakeforge.dox \
qw-cap-spec.dox qw-download-spec.dox surround-sound.dox timestamps.dox qw-cap-spec.dox qw-download-spec.dox surround-sound.dox timestamps.dox
EXTRA_DIST= qf.ico \ EXTRA_DIST= qf.ico \

View file

@ -1,13 +1,13 @@
//unfortunatly, have to wrap the docs in a C comment for doxygen //unfortunatly, have to wrap the docs in a C comment for doxygen
/** /**
\page property-lists Property Lists \page property-list Property List
\QF's property lists are based on those used in OpenStep. \QF's property lists are based on those used in OpenStep.
\QF uses property lists for a wide variety of purposes. This includes saved \QF uses property lists for a wide variety of purposes. This includes saved
game data, directory configuration and play-lists. game data, directory configuration and play-lists.
Property lists are text files that describe a single value. However, that A property list is a text file that describes a single value. However, that
value can be one of the following types: value can be one of the following types:
<dl> <dl>
<dt>Dictionaries</dt> <dd>Lists of values that are each accociated <dt>Dictionaries</dt> <dd>Lists of values that are each accociated

View file

@ -38,7 +38,7 @@
/** The type of the property list item. /** The type of the property list item.
For further details, see \ref property-lists. For further details, see \ref property-list.
*/ */
typedef enum { typedef enum {
QFDictionary, ///< The property list item represents a dictionary. QFDictionary, ///< The property list item represents a dictionary.