From 6268bd2965a6810d4d0a4bb92b00059d6db3d84d Mon Sep 17 00:00:00 2001 From: Bill Currie Date: Sat, 20 Aug 2011 19:23:31 +0900 Subject: [PATCH] Tweak the property list docs a little. --- doc/Makefile.am | 2 +- doc/{property-lists.dox => property-list.dox} | 4 ++-- include/QF/qfplist.h | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) rename doc/{property-lists.dox => property-list.dox} (96%) diff --git a/doc/Makefile.am b/doc/Makefile.am index 6d83fb2f0..395621e84 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,7 +4,7 @@ SUBDIRS= man 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 EXTRA_DIST= qf.ico \ diff --git a/doc/property-lists.dox b/doc/property-list.dox similarity index 96% rename from doc/property-lists.dox rename to doc/property-list.dox index fcdeef9f6..bc4338c00 100644 --- a/doc/property-lists.dox +++ b/doc/property-list.dox @@ -1,13 +1,13 @@ //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 uses property lists for a wide variety of purposes. This includes saved 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:
Dictionaries
Lists of values that are each accociated diff --git a/include/QF/qfplist.h b/include/QF/qfplist.h index f040c77f3..a7e0fbb53 100644 --- a/include/QF/qfplist.h +++ b/include/QF/qfplist.h @@ -38,7 +38,7 @@ /** The type of the property list item. - For further details, see \ref property-lists. + For further details, see \ref property-list. */ typedef enum { QFDictionary, ///< The property list item represents a dictionary.