diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2001-08-12 16:26:14 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2001-08-12 16:26:14 (GMT) |
commit | b5cbb79d114ed13945bc882ac8eef1c2be967bbf (patch) | |
tree | 4c0dd6f4a7ff503dd3cacaa8e6156c9975645e66 /doc | |
parent | 490b7178adcf627892b0686b80016422e64dcfa3 (diff) | |
download | Doxygen-b5cbb79d114ed13945bc882ac8eef1c2be967bbf.zip Doxygen-b5cbb79d114ed13945bc882ac8eef1c2be967bbf.tar.gz Doxygen-b5cbb79d114ed13945bc882ac8eef1c2be967bbf.tar.bz2 |
Release-1.2.9-20010812
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 10 | ||||
-rw-r--r-- | doc/config.doc | 7 | ||||
-rw-r--r-- | doc/index.doc | 4 | ||||
-rw-r--r-- | doc/preprocessing.doc | 67 |
4 files changed, 69 insertions, 19 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index cd2a634..d9cf37f 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -101,6 +101,7 @@ documentation: <li> \refitem cmdnote \note <li> \refitem cmdoverload \overload <li> \refitem cmdp \p +<li> \refitem cmdpackage \package <li> \refitem cmdpage \page <li> \refitem cmdpar \par <li> \refitem cmdparam \param @@ -406,6 +407,8 @@ doxygen. Unrecognized commands are treated as normal text. */ \endverbatim + You can refer to the main page using \\ref index. + \sa section \ref cmdsection "\\section", section \ref cmdsubsection "\\subsection" and section \ref cmdpage "\\page". @@ -468,6 +471,13 @@ Public/Protected/Private/... section. \endhtmlonly <hr> +\subsection cmdpackage \package <name> + + \addindex \package + Indicates that a comment block contains documentation for a + Java package with name \<name\>. + +<hr> \subsection cmdpage \page <name> (title) \addindex \page diff --git a/doc/config.doc b/doc/config.doc index e4f021d..4d5b92f 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -171,6 +171,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_strip_from_path STRIP_FROM_PATH <li> \refitem cfg_tab_size TAB_SIZE <li> \refitem cfg_tagfiles TAGFILES +<li> \refitem cfg_template_relations TEMPLATE_RELATIONS <li> \refitem cfg_toc_expand TOC_EXPAND <li> \refitem cfg_treeview_width TREEVIEW_WIDTH <li> \refitem cfg_verbatim_headers VERBATIM_HEADERS @@ -1149,6 +1150,12 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. +\anchor cfg_template_relations +<dt>\c TEMPLATE_RELATIONS <dd> + \addindex TEMPLATE_RELATIONS + If the \c TEMPLATE_RELATIONS and \c HAVE_DOT tags are set to \c YES then + doxygen will show the relations between templates and their instances. + \anchor cfg_include_graph <dt>\c INCLUDE_GRAPH <dd> \addindex INCLUDE_GRAPH diff --git a/doc/index.doc b/doc/index.doc index 99e6d7c..9c030cb 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -173,8 +173,10 @@ Thanks go to: Boris Bralo, Nickolay Semyonov, Richard Kim, Földvári György, Grzegorz Kowal, and Wang Weihan for providing translations into various languages. +<li>Erik Jan Lingen of <a href="http://www.habanera.nl/">Habanera</a> for + donating money. <li>The Comms group of <a href="http://www.symbian.com">Symbian</a> for donating - me an ultra cool <a href="http://www.psion.com/revoplus>Revo plus</a> + an ultra cool <a href="http://www.psion.com/revoplus>Revo plus</a> organizer! <li>The band <a href="http://www.porcupinetree.com">Porcupine Tree</a> for providing hours of great music to listen to while coding. diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index 19f730d..524f7c5 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -152,26 +152,57 @@ for class QList is to define: PREDEFINED = QListT:=QList \endverbatim -Here is example provided by Valter Minute that helps doxygen to -wade through the boilerplate code in Microsoft's ATL library: +Here is an example provided by Valter Minute & Reyes Ponce that helps +doxygen to wade through the boilerplate code in Microsoft's ATL & MFC +libraries: \verbatim -PREDEFINED = DECLARE_REGISTRY_RESOURCEID=// \ - DECLARE_PROTECT_FINAL_CONSTRUCT=// \ - BEGIN_COM_MAP=/* \ - END_COM_MAP=*/// \ - BEGIN_PROP_MAP=/* \ - END_PROP_MAP=*/// \ - BEGIN_MSG_MAP=/* \ - END_MSG_MAP=*/// \ - DECLARE_VIEW_STATUS=// \ - "STDMETHOD(a)=HRESULT a" \ - "ATL_NO_VTABLE= "\ - "__declspec(a)= "\ - BEGIN_CONNECTION_POINT_MAP=/* \ - END_CONNECTION_POINT_MAP=*/// \ - "DECLARE_AGGREGATABLE(Class)= " \ - "DECLARE_REGISTRY_RESOURCEID(id)= " +PREDEFINED = "DECLARE_INTERFACE(name)=class name" \ + "STDMETHOD(result,name)=virtual result name" \ + "PURE= = 0" \ + THIS_= \ + THIS= \ + DECLARE_REGISTRY_RESOURCEID=// \ + DECLARE_PROTECT_FINAL_CONSTRUCT=// \ + "DECLARE_AGGREGATABLE(Class)= " \ + "DECLARE_REGISTRY_RESOURCEID(Id)= " \ + DECLARE_MESSAGE_MAP = \ + BEGIN_MESSAGE_MAP=/* \ + END_MESSAGE_MAP=*/// \ + BEGIN_COM_MAP=/* \ + END_COM_MAP=*/// \ + BEGIN_PROP_MAP=/* \ + END_PROP_MAP=*/// \ + BEGIN_MSG_MAP=/* \ + END_MSG_MAP=*/// \ + BEGIN_PROPERTY_MAP=/* \ + END_PROPERTY_MAP=*/// \ + BEGIN_OBJECT_MAP=/* \ + END_OBJECT_MAP()=*/// \ + DECLARE_VIEW_STATUS=// \ + "STDMETHOD(a)=HRESULT a" \ + "ATL_NO_VTABLE= " \ + "__declspec(a)= " \ + BEGIN_CONNECTION_POINT_MAP=/* \ + END_CONNECTION_POINT_MAP=*/// \ + "DECLARE_DYNAMIC(class)= " \ + "IMPLEMENT_DYNAMIC(class1, class2)= " \ + "DECLARE_DYNCREATE(class)= " \ + "IMPLEMENT_DYNCREATE(class1, class2)= " \ + "IMPLEMENT_SERIAL(class1, class2, class3)= " \ + "DECLARE_MESSAGE_MAP()= " \ + TRY=try \ + "CATCH_ALL(e)= catch(...)" \ + END_CATCH_ALL= \ + "THROW_LAST()= throw"\ + "RUNTIME_CLASS(class)=class" \ + "MAKEINTRESOURCE(nId)=nId" \ + "IMPLEMENT_REGISTER(v, w, x, y, z)= " \ + "ASSERT(x)=assert(x)" \ + "ASSERT_VALID(x)=assert(x)" \ + "TRACE0(x)=printf(x)" \ + "OS_ERR(A,B)={ #A, B }" \ + __cplusplus \endverbatim As you can see doxygen's preprocessor is quite powerful, but if you want |