diff --git a/README.md b/README.md index 3b885be..978f67e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # doxygen +Doxygen is a documentation system for C++, C, Java, IDL (Corba and Microsoft flavors) and to some extent PHP and C# and D. +It can help you in three ways: + * It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in HTML) from a set of documented source files. + There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. + The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. + * You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. + You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. + * You can even `abuse' doxygen for creating normal documentation (as I did for this manual). + +Doxygen is developed under Linux, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows 9x/NT and Mac OS X are available. + diff --git a/doxygen-1.6.2-timestamp.patch b/doxygen-1.6.2-timestamp.patch new file mode 100644 index 0000000..c7b45a3 --- /dev/null +++ b/doxygen-1.6.2-timestamp.patch @@ -0,0 +1,61 @@ +diff -up doxygen-1.6.2/src/configoptions.cpp.timestamp doxygen-1.6.2/src/configoptions.cpp +--- doxygen-1.6.2/src/configoptions.cpp.timestamp 2009-12-28 11:39:11.000000000 +0100 ++++ doxygen-1.6.2/src/configoptions.cpp 2010-01-04 11:58:33.000000000 +0100 +@@ -1088,6 +1088,14 @@ void addConfigOptions(Config *cfg) + cs->setWidgetType(ConfigString::File); + cs->addDependency("GENERATE_HTML"); + //---- ++ cb = cfg->addBool( ++ "HTML_TIMESTAMP", ++ "If the HTML_TIMESTAMP tag is set to YES then the generated HTML\n" ++ "documentation will contain the timesstamp.", ++ FALSE ++ ); ++ cb->addDependency("GENERATE_HTML"); ++ //---- + cs = cfg->addString( + "HTML_STYLESHEET", + "The HTML_STYLESHEET tag can be used to specify a user-defined cascading\n" +diff -up doxygen-1.6.2/src/config.xml.timestamp doxygen-1.6.2/src/config.xml +--- doxygen-1.6.2/src/config.xml.timestamp 2009-12-28 11:38:55.000000000 +0100 ++++ doxygen-1.6.2/src/config.xml 2010-01-04 11:58:33.000000000 +0100 +@@ -761,6 +761,10 @@ The HTML_FOOTER tag can be used to speci + each generated HTML page. If it is left blank doxygen will generate a + standard footer. + ' defval='' depends='GENERATE_HTML'/> ++