From b20ff12b9d8fa90143628233319beec2c20266d7 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Fri, 15 Nov 2002 14:41:06 +0000 Subject: Release-1.3-rc1 --- INSTALL | 7 +-- README | 4 +- VERSION | 2 +- addon/doxmlparser/include/doxmlintf.h | 2 +- addon/doxmlparser/src/doxmlintf.h | 2 +- doc/config.doc | 72 +++++++++++++++++++++++++++-- doc/doxysearch_usage.doc | 2 +- doc/features.doc | 3 +- doc/htmlcmds.doc | 5 +- doc/language.doc | 2 +- examples/class.h | 2 +- examples/example.cfg | 20 ++++---- examples/page.doc | 4 +- packages/rpm/doxygen.spec | 2 +- src/classdef.cpp | 12 +++-- src/config.l | 10 +++- src/docparser.cpp | 15 +++++- src/doctokenizer.l | 12 +++-- src/doxygen.cpp | 4 +- src/filedef.cpp | 8 +++- src/htmlgen.cpp | 2 + src/mangen.cpp | 1 - src/namespacedef.cpp | 8 +++- src/pre.l | 18 ++++---- src/scanner.l | 86 +++++++++++++++++++++++++---------- src/translator_sr.h | 18 ++++++-- src/util.cpp | 85 +++++++++++++++++++++++++++++++--- 27 files changed, 325 insertions(+), 83 deletions(-) diff --git a/INSTALL b/INSTALL index f1ec438..6bddd2a 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,7 @@ -DOXYGEN Version 1.2.18-20021106 +DOXYGEN Version 1.3-rc1 -Please read the installation section of the manual for instructions. +Please read the installation section of the manual +(http://www.doxygen.org/install.html) for instructions. -------- -Dimitri van Heesch (06 November 2002) +Dimitri van Heesch (15 November 2002) diff --git a/README b/README index fd92766..64c9bbc 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.2.18_20021106 +DOXYGEN Version 1.3_rc1 Please read INSTALL for compilation instructions. @@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (06 November 2002) +Dimitri van Heesch (dimitri@stack.nl) (15 November 2002) diff --git a/VERSION b/VERSION index 5422fca..b03dc3a 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.18-20021106 +1.3-rc1 diff --git a/addon/doxmlparser/include/doxmlintf.h b/addon/doxmlparser/include/doxmlintf.h index 6432ee3..a136d61 100644 --- a/addon/doxmlparser/include/doxmlintf.h +++ b/addon/doxmlparser/include/doxmlintf.h @@ -20,7 +20,7 @@ * \brief The interface to the object model provided by the XML parser * library. * - * To start using this library one calls createObjectModel and then + * To start using this library one calls createObjectModel() and then * uses the returned IDoxygen interface to read doxygen generated * XML output and navigate through the information contained in it. * diff --git a/addon/doxmlparser/src/doxmlintf.h b/addon/doxmlparser/src/doxmlintf.h index 6432ee3..a136d61 100644 --- a/addon/doxmlparser/src/doxmlintf.h +++ b/addon/doxmlparser/src/doxmlintf.h @@ -20,7 +20,7 @@ * \brief The interface to the object model provided by the XML parser * library. * - * To start using this library one calls createObjectModel and then + * To start using this library one calls createObjectModel() and then * uses the returned IDoxygen interface to read doxygen generated * XML output and navigate through the information contained in it. * diff --git a/doc/config.doc b/doc/config.doc index d6a9fd7..f94f8e8 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -101,6 +101,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_file_patterns FILE_PATTERNS \refitem cfg_filter_source_files FILTER_SOURCE_FILES \refitem cfg_full_path_names FULL_PATH_NAMES +\refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF \refitem cfg_generate_buglist GENERATE_BUGLIST \refitem cfg_generate_chi GENERATE_CHI \refitem cfg_generate_todolist GENERATE_DEPRECIATELIST @@ -109,6 +110,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_generate_latex GENERATE_LATEX \refitem cfg_generate_legend GENERATE_LEGEND \refitem cfg_generate_man GENERATE_MAN +\refitem cfg_generate_perlmod GENERATE_PERLMOD \refitem cfg_generate_rtf GENERATE_RTF \refitem cfg_generate_tagfile GENERATE_TAGFILE \refitem cfg_generate_testlist GENERATE_TESTLIST @@ -119,6 +121,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_have_dot HAVE_DOT \refitem cfg_hhc_location HHC_LOCATION \refitem cfg_hide_friend_compounds HIDE_FRIEND_COMPOUNDS +\refitem cfg_hide_in_body_docs HIDE_IN_BODY_DOCS \refitem cfg_hide_scope_names HIDE_SCOPE_NAMES \refitem cfg_hide_undoc_classes HIDE_UNDOC_CLASSES \refitem cfg_hide_undoc_members HIDE_UNDOC_MEMBERS @@ -160,6 +163,9 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_paper_type PAPER_TYPE \refitem cfg_pdf_hyperlinks PDF_HYPERLINKS \refitem cfg_perl_path PERL_PATH +\refitem cfg_perlmod_latex PERLMOD_LATEX +\refitem cfg_perlmod_pretty PERLMOD_PRETTY +\refitem cfg_perlmod_makevar_prefix PERLMOD_MAKEVAR_PREFIX \refitem cfg_predefined PREDEFINED \refitem cfg_project_name PROJECT_NAME \refitem cfg_project_number PROJECT_NUMBER @@ -291,6 +297,14 @@ followed by the descriptions of the tags grouped by category. If set to \c NO (the default) these declarations will be included in the documentation. +\anchor cfg_hide_in_body_docs +
\c HIDE_IN_BODY_DOCS
+ \addindex HIDE_IN_BODY_DOCS +If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, Doxygen will hide any +documentation blocks found inside the body of a function. +If set to \c NO (the default) these blocks will be appended to the +function's detailed documentation block. + \anchor cfg_brief_member_desc
\c BRIEF_MEMBER_DESC
\addindex BRIEF_MEMBER_DESC @@ -1150,26 +1164,78 @@ EXTRA_PACKAGES = times
\c GENERATE_XML
\addindex GENERATE_XML - If the GENERATE_XML tag is set to YES Doxygen will + If the \c GENERATE_XML tag is set to \c YES Doxygen will generate an XML file that captures the structure of the code including all documentation. \anchor cfg_xml_schema
\c XML_SCHEMA
\addindex XML_SCHEMA - The XML_SCHEMA tag can be used to specify an XML schema, + The \c XML_SCHEMA tag can be used to specify an XML schema, which can be used by a validating XML parser to check the syntax of the XML files. \anchor cfg_xml_dtd
\c XML_DTD
\addindex XML_DTD - The XML_DTD tag can be used to specify an XML DTD, + The \c XML_DTD tag can be used to specify an XML DTD, which can be used by a validating XML parser to check the syntax of the XML files. +\section autogen_output AUTOGEN_DEF related options +\anchor cfg_generate_autogen_def +
+ +
\c GENERATE_AUTOGEN_DEF
+ \addindex GENERATE_AUTOGEN_DEF + If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES Doxygen will + generate an AutoGen Definitions (see http://autogen.sf.net) file + that captures the structure of the code including all + documentation. Note that this feature is still experimental + and incomplete at the moment. + +
+ +\section perlmod_output PERLMOD related options +\anchor cfg_generate_perlmod +
+ +
\c GENERATE_PERLMOD
+ \addindex GENERATE_PERLMOD + If the \c GENERATE_PERLMOD tag is set to \c YES Doxygen will + generate a Perl module file that captures the structure of + the code including all documentation. Note that this + feature is still experimental and incomplete at the + moment. + +\anchor cfg_perlmod_latex +
\c PERLMOD_LATEX
+ \addindex PERLMOD_LATEX + If the \c PERLMOD_LATEX tag is set to \c YES Doxygen will generate + the necessary Makefile rules, Perl scripts and LaTeX code to be able + to generate PDF and DVI output from the Perl module output. + +\anchor cfg_perlmod_pretty +
\c PERLMOD_PRETTY
+ \addindex PERLMOD_PRETTY + If the \c PERLMOD_PRETTY tag is set to \c YES the Perl module output will be + nicely formatted so it can be parsed by a human reader. This is useful + if you want to understand what is going on. On the other hand, if this + tag is set to \c NO the size of the Perl module output will be much smaller + and Perl will parse it just the same. + +\anchor cfg_perlmod_makevar_prefix +
\c PERLMOD_MAKEVAR_PREFIX
+ \addindex PERLMOD_MAKEVAR_PREFIX + The names of the make variables in the generated doxyrules.make file + are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX. + This is useful so different doxyrules.make files included by the same + Makefile don't overwrite each other's variables. + +
+ \section config_prepro Preprocessor related options \anchor cfg_enable_preprocessing
diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index 46a3de1..51d3d46 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -131,7 +131,7 @@ This can be done by carefully following these steps: \par Note: Doxytag requires quite a large amount of memory to generate the search index (about 30 MB on my Linux box)! - The resulting index file requires about 3 MB space on your disk. + The resulting index file requires about 3 MB of space on your disk.
  • Edit the shell script search.cgi with a text editor. diff --git a/doc/features.doc b/doc/features.doc index 806a5b5..3d5e985 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -21,7 +21,8 @@
  • Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. -
  • Supports C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources. +
  • Supports C/C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, + IDL, and to some extent C# and PHP sources.
  • Supports documentation of files, namespaces, classes, structs, unions, templates, variables, functions, typedefs, enums and defines.
  • JavaDoc (1.1), Qt-Doc, and KDOC compatible. diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 96b22f5..eadb8d1 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -17,8 +17,9 @@ /*! \page htmlcmds HTML Commands Here is a list of all HTML commands that may be used inside the -documentation. Note that all attributes of a HTML tag are ignored -(the HREF and NAME attributes for the A tag are the only exception). +documentation. Note that all attributes of a HTML tag are passed on to +the HTML output only (the HREF and NAME attributes for the A tag are the +only exception).