From e908bacaa1f3309e2d06049a2555d978d3d7e7f9 Mon Sep 17 00:00:00 2001 From: lottaviano Date: Tue, 29 Sep 2009 12:39:19 +0000 Subject: [PATCH] doc: Various fixes to documentation infrastructure - Move all doc related files to doc/ - Use INPUT directive to correctly generate docs - Move FILE_PATTERNS to common Doxyfile git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2992 38d2e660-2303-0410-9eaa-f027e97ec537 --- Doxyfile | 16 ++++++---------- Doxyfile-common | 12 +++++++++++- Doxyfile-offline | 17 ++++++----------- Doxyfile-snapshot | 20 ++++++++------------ Mainpage.online => doc/Mainpage.online | 0 Mainpage.snapshot => doc/Mainpage.snapshot | 4 ++-- README.bertos => doc/README.bertos | 0 STATUS => doc/STATUS | 0 8 files changed, 33 insertions(+), 36 deletions(-) rename Mainpage.online => doc/Mainpage.online (100%) rename Mainpage.snapshot => doc/Mainpage.snapshot (97%) rename README.bertos => doc/README.bertos (100%) rename STATUS => doc/STATUS (100%) diff --git a/Doxyfile b/Doxyfile index efbf87a2..2ba9bf1b 100644 --- a/Doxyfile +++ b/Doxyfile @@ -9,16 +9,12 @@ OUTPUT_DIRECTORY = doc/reference -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 - -FILE_PATTERNS = *.h \ - Mainpage.online \ - *.c +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT += doc/Mainpage.online # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a diff --git a/Doxyfile-common b/Doxyfile-common index d728550e..6b9d751a 100644 --- a/Doxyfile-common +++ b/Doxyfile-common @@ -552,7 +552,17 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT += bertos/ + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h \ + *.c # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/Doxyfile-offline b/Doxyfile-offline index be718f6b..80b361a8 100644 --- a/Doxyfile-offline +++ b/Doxyfile-offline @@ -10,18 +10,13 @@ OUTPUT_DIRECTORY = doc/offline-reference +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 - -FILE_PATTERNS = *.h \ - README.bertos \ - *.c \ - STATUS +INPUT += doc/README.bertos \ + doc/STATUS # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a diff --git a/Doxyfile-snapshot b/Doxyfile-snapshot index 07100ba2..d4bbed28 100644 --- a/Doxyfile-snapshot +++ b/Doxyfile-snapshot @@ -7,18 +7,14 @@ # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = doc/reference - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 - -FILE_PATTERNS = *.h \ - Mainpage.snapshot \ - *.c +OUTPUT_DIRECTORY = doc/reference-snapshot + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT += doc/Mainpage.snapshot # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a diff --git a/Mainpage.online b/doc/Mainpage.online similarity index 100% rename from Mainpage.online rename to doc/Mainpage.online diff --git a/Mainpage.snapshot b/doc/Mainpage.snapshot similarity index 97% rename from Mainpage.snapshot rename to doc/Mainpage.snapshot index b20936de..5e50e27b 100644 --- a/Mainpage.snapshot +++ b/doc/Mainpage.snapshot @@ -10,8 +10,8 @@ See STATUS for further information and tips about Doxygen tags. \mainpage -This documentation is generated from BeRTOS SVN. As such, it may contain modules -and/or additional documentation not present in official releases. +This documentation is generated from BeRTOS SVN. As such, it may contain modules +and/or additional documentation not present in official releases. \section overview Overview diff --git a/README.bertos b/doc/README.bertos similarity index 100% rename from README.bertos rename to doc/README.bertos diff --git a/STATUS b/doc/STATUS similarity index 100% rename from STATUS rename to doc/STATUS -- 2.25.1