diff options
author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2004-03-07 21:00:29 (GMT) |
---|---|---|
committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2004-03-07 21:00:29 (GMT) |
commit | f12fe31aed103718f5d4c368473302cc6ac82a47 (patch) | |
tree | ecc570be1c038ecdb55dda6d9ffe794945151261 /doc | |
parent | 5edb3c85109d09e5fa43529bf8b584382f7501a5 (diff) | |
download | Doxygen-f12fe31aed103718f5d4c368473302cc6ac82a47.zip Doxygen-f12fe31aed103718f5d4c368473302cc6ac82a47.tar.gz Doxygen-f12fe31aed103718f5d4c368473302cc6ac82a47.tar.bz2 |
Release-1.3.6-20040307
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 11 | ||||
-rw-r--r-- | doc/config.doc | 9 | ||||
-rw-r--r-- | doc/grouping.doc | 8 | ||||
-rw-r--r-- | doc/language.doc | 2 | ||||
-rw-r--r-- | doc/translator.py | 2 |
5 files changed, 30 insertions, 2 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index b315af3..4d3d804 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -109,6 +109,7 @@ documentation: \refitem cmdparam \\param \refitem cmdpost \\post \refitem cmdpre \\pre +\refitem cmdproperty \\property \refitem cmdref \\ref \refitem cmdrelates \\relates \refitem cmdrelatesalso \\relatesalso @@ -540,6 +541,16 @@ See section \ref memgroup for an example. \ref cmdref "\\ref". <hr> +\section cmdproperty \property (qualified property name) + + \addindex \\property + Indicates that a comment block contains documentation for a + property (either global or as a member of a class). + This command is equivalent to \\var and \\fn. + + \sa section \ref cmdfn "\\fn" and \ref cmdvar "\\var". + +<hr> \section cmdrelates \relates <name> \addindex \\relates diff --git a/doc/config.doc b/doc/config.doc index ca6105d..fb671b8 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -92,6 +92,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_extra_packages EXTRA_PACKAGES \refitem cfg_extract_all EXTRACT_ALL \refitem cfg_extract_local_classes EXTRACT_LOCAL_CLASSES +\refitem cfg_extract_local_methods EXTRACT_LOCAL_METHODS \refitem cfg_extract_private EXTRACT_PRIVATE \refitem cfg_extract_static EXTRACT_STATIC \refitem cfg_file_patterns FILE_PATTERNS @@ -467,6 +468,14 @@ followed by the descriptions of the tags grouped by category. If set to NO only classes defined in header files are included. Does not have any effect for Java sources. +\anchor cfg_extract_local_methods +<dt>\c EXTRACT_LOCAL_METHODS <dd> + \addindex EXTRACT_LOCAL_METHODS + This flag is only useful for Objective-C code. When set to \c YES local + methods, which are defined in the implementation section but not in + the interface are included in the documentation. + If set to \c NO (the default) only methods in the interface are included. + \anchor cfg_hide_undoc_members <dt>\c HIDE_UNDOC_MEMBERS <dd> \addindex HIDE_UNDOC_MEMBERS diff --git a/doc/grouping.doc b/doc/grouping.doc index 2a1fe89..e87b596 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -105,6 +105,14 @@ int IntegerVariable; /*@}*/ \endverbatim +The \ref cmdref "\\ref" command can be used to refer to a group. +The first argument of the \\ref command should be group's label. +To use a custom link name, you can put the name of the links in +double quotes after the label, as shown by the following example +\verbatim +This is the \ref group_label "link" to this group. +\endverbatim + The priorities of grouping definitions are (from highest to lowest): \ref cmdingroup "\\ingroup", \ref cmddefgroup "\\defgroup", \ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup". diff --git a/doc/language.doc b/doc/language.doc index dcb3783..fb25b1b 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.3.6), 28 languages +Currently (version 1.3.6-20040222), 28 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, Greek, diff --git a/doc/translator.py b/doc/translator.py index aa182f0..4ec7d2f 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -1266,7 +1266,7 @@ class TrManager: self.numLang -= 1 # the couple will be counted as one # Extract the version of Doxygen. - f = file(os.path.join(self.doxy_path, 'version')) + f = file(os.path.join(self.doxy_path, 'VERSION')) self.doxVersion = f.readline().strip() f.close() |