diff options
author | DongHun Kwak <dh0128.kwak@samsung.com> | 2021-10-15 10:54:13 +0900 |
---|---|---|
committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2021-10-15 10:54:13 +0900 |
commit | d6f1e74d173f59fc63d7e031cd9685b4eb38fed2 (patch) | |
tree | d50bd7e36be4511530c4159c74d29b7bcedc0d71 /doc | |
parent | 021ee4c58494575f9f4eaedeba447a18b22ca4c1 (diff) | |
download | doxygen-d6f1e74d173f59fc63d7e031cd9685b4eb38fed2.tar.gz doxygen-d6f1e74d173f59fc63d7e031cd9685b4eb38fed2.tar.bz2 doxygen-d6f1e74d173f59fc63d7e031cd9685b4eb38fed2.zip |
Imported Upstream version 1.8.14upstream/1.8.14
Diffstat (limited to 'doc')
-rw-r--r-- | doc/CMakeLists.txt | 13 | ||||
-rw-r--r-- | doc/arch.doc | 16 | ||||
-rw-r--r-- | doc/changelog.doc | 127 | ||||
-rw-r--r-- | doc/commands.doc | 22 | ||||
-rw-r--r-- | doc/custcmd.doc | 4 | ||||
-rw-r--r-- | doc/customize.doc | 4 | ||||
-rw-r--r-- | doc/docblocks.doc | 14 | ||||
-rw-r--r-- | doc/extsearch.doc | 12 | ||||
-rw-r--r-- | doc/faq.doc | 2 | ||||
-rw-r--r-- | doc/formulas.doc | 2 | ||||
-rw-r--r-- | doc/grouping.doc | 2 | ||||
-rw-r--r-- | doc/index.doc | 2 | ||||
-rw-r--r-- | doc/install.doc | 24 | ||||
-rw-r--r-- | doc/language.tpl | 6 | ||||
-rw-r--r-- | doc/markdown.doc | 24 | ||||
-rw-r--r-- | doc/preprocessing.doc | 2 | ||||
-rw-r--r-- | doc/searching.doc | 4 | ||||
-rw-r--r-- | doc/starting.doc | 2 |
18 files changed, 205 insertions, 77 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 8b51134..b95afd8 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -11,8 +11,6 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -if (build_doc) - include (${TOP}/cmake/version.cmake) string(TIMESTAMP DATE "%d-%m-%Y") @@ -20,6 +18,7 @@ find_package(PythonInterp REQUIRED) find_program(EPSTOPDF NAMES epstopdf ) find_program(PDFLATEX NAMES pdflatex ) find_program(MAKEINDEX NAMES makeindex ) +include(GNUInstallDirs) if (doxygen_BINARY_DIR) set(DOXYGEN_EXECUTABLE ${doxygen_BINARY_DIR}/bin/doxygen) @@ -87,9 +86,9 @@ set(DOC_FILES ) file(GLOB LANG_FILES "${TOP}/src/translator_??.h") -file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/man) -file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/src) -file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/doc) +file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/man + ${PROJECT_BINARY_DIR}/src + ${PROJECT_BINARY_DIR}/doc) file(COPY ${TOP}/VERSION DESTINATION ${PROJECT_BINARY_DIR}/) file(COPY ${TOP}/src/translator.h DESTINATION ${PROJECT_BINARY_DIR}/src/) @@ -169,7 +168,7 @@ install(FILES "${PROJECT_BINARY_DIR}/man/doxywizard.1" "${PROJECT_BINARY_DIR}/man/doxysearch.1" "${PROJECT_BINARY_DIR}/man/doxyindexer.1" - DESTINATION share/man/man1 + DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 ) install(FILES @@ -181,5 +180,3 @@ install(DIRECTORY "${PROJECT_BINARY_DIR}/html" DESTINATION "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}" ) - -endif(build_doc) diff --git a/doc/arch.doc b/doc/arch.doc index 4b17d7c..e5fbbdc 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -205,27 +205,27 @@ $file = shift @ARGV; print "Toggle debugging mode for $file\n"; if (!-e "../src/${file}.l") { - print STDERR "Error: file ../src/${file}.l does not exist!"; + print STDERR "Error: file ../src/${file}.l does not exist!\n"; exit 1; } system("touch ../src/${file}.l"); -unless (rename "src/CMakeFiles/_doxygen.dir/build.make","src/CMakefiles/_doxygen.dir/build.make.old") { +unless (rename "src/CMakeFiles/_doxygen.dir/build.make","src/CMakeFiles/_doxygen.dir/build.make.old") { print STDERR "Error: cannot rename src/CMakeFiles/_doxygen.dir/build.make!\n"; exit 1; } if (open(F,"<src/CMakeFiles/_doxygen.dir/build.make.old")) { - unless (open(G,">src/CMakefiles/_doxygen.dir/build.make")) { + unless (open(G,">src/CMakeFiles/_doxygen.dir/build.make")) { print STDERR "Error: opening file build.make for writing\n"; exit 1; } print "Processing build.make...\n"; while (<F>) { - if ( s/flex \$\(LEX_FLAGS\) -P${file}YY/flex \$(LEX_FLAGS) -d -P${file}YY/ ) { - print "Enabling debug info for $file.l\n"; - } - elsif ( s/flex \$\(LEX_FLAGS\) -d -P${file}YY/flex \$(LEX_FLAGS) -P${file}YY/ ) { + if ( s/flex \$\(LEX_FLAGS\) -d(.*) ${file}.l/flex \$(LEX_FLAGS)$1 ${file}.l/ ) { print "Disabling debug info for $file\n"; } + elsif ( s/flex \$\(LEX_FLAGS\)(.*) ${file}.l$/flex \$(LEX_FLAGS) -d$1 ${file}.l/ ) { + print "Enabling debug info for $file.l\n"; + } print G "$_"; } close F; @@ -237,7 +237,7 @@ else { # touch the file $now = time; -utime $now, $now, $file +utime $now, $now, $file; \endverbatim Another way to get rules matching / debugging information from the \c flex code is setting LEX_FLAGS with \c make (`make LEX_FLAGS=-d`). diff --git a/doc/changelog.doc b/doc/changelog.doc index c5b2e3f..3efb31e 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -2,6 +2,133 @@ \tableofcontents \section log_1_8 1.8 Series +\subsection log_1_8_14 Release 1.8.14 +\htmlonly +<b>(release date 25-12-2017)</b> +<a name="1.8.14"></a> +</p> +<ul> +<li>Add language type attribute to programlisting tag [<a href="http://github.com/doxygen/doxygen/commit/141dbfd5a4f79c98da14a1b414c6db4e1b34618b">view</a>] +<li>Add links behind nav entries "Namespaces" and "Files" (matching "Classes") [<a href="http://github.com/doxygen/doxygen/commit/464919adf1cdae9057ff840f40c60472b4c30bfd">view</a>] +<li>Allow case insensitive file pattern matching based on CASE_SENSE_NAMES [<a href="http://github.com/doxygen/doxygen/commit/bd759f9a3aa4096bc8574ea45ad6b23fed830742">view</a>] +<li>Async load of mathjax javascript [<a href="http://github.com/doxygen/doxygen/commit/340e516dbf5efd3ae21d964e92369e97b252e4ab">view</a>] +<li>Avoid generating unused dir_* output files for non HTML output formats [<a href="http://github.com/doxygen/doxygen/commit/38987846ec0752b8deee7bab69c7890aa861af00">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=557094">557094</a> - Wrong spacing in function names with french language (latex output) [<a href="http://github.com/doxygen/doxygen/commit/9d478d2fedd091ceac8e689507676292f5455882">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=652086">652086</a> - does ALIAS work for VHDL code? [<a href="http://github.com/doxygen/doxygen/commit/05364c46f806e73cce76be37a6a31230d0468507">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=729237">729237</a> - (UnFriendlyTemplate) Spurious warning when documenting friend template [<a href="http://github.com/doxygen/doxygen/commit/2fe7bc7f1df9a2483355b0743b5e0455aaccc969">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=733705">733705</a> - parser misinterpreting fortran [<a href="http://github.com/doxygen/doxygen/commit/747fc768476aef8b8b70fdd78749702a410dcd29">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=743367">743367</a> - Duplicate attribute (target="_top" target="_top") generated in .SVG files [<a href="http://github.com/doxygen/doxygen/commit/97bfbfa6c4d4eb07ac8c60545086c3370e9683b8">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=775493">775493</a> - Usage of underscore's in parameter names [<a href="http://github.com/doxygen/doxygen/commit/c10af45c61a1f9b25c514f397ace16c94cc7c8df">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=776791">776791</a> - [1.8.13 Regression] Segfault building the breathe docs [<a href="http://github.com/doxygen/doxygen/commit/0f02761a158a5e9ddbd5801682482af8986dbc35">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=776870">776870</a> - XML Parsing Error for operator<< methods when outputing to XHTML [<a href="http://github.com/doxygen/doxygen/commit/0e8530e42b69c909ef2c26468b24dfb88cc0997f">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=776964">776964</a> - Menu does not work without Javascript [<a href="http://github.com/doxygen/doxygen/commit/1be97720b7820361e85242d08d4cac3e46570bfe">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=776988">776988</a> - Too greedy behavior of @ref const matching [<a href="http://github.com/doxygen/doxygen/commit/04001c8926fb0f37dfcf284b3637b182125bba75">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=778730">778730</a> - doxygen build fails [<a href="http://github.com/doxygen/doxygen/commit/bb5c8dd29782ecbb05a4ef9788f2507e9a156848">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=779014">779014</a> - Add "\~" command to internatioalization article [<a href="http://github.com/doxygen/doxygen/commit/e204b982eebd54bd15148a520da6608935e33e50">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=784281">784281</a> - Problem RTF output: The class list "classes" within the namespace report is wrong indicated. [<a href="http://github.com/doxygen/doxygen/commit/753c06281f6b2e9172c449157fc9f863063232e3">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=786409">786409</a> - parsing error in Fortran file with preprocessing [<a href="http://github.com/doxygen/doxygen/commit/2f5e22a4be9d237a150d04659bf6abec1349fbd9">view</a>] +, [<a href="http://github.com/doxygen/doxygen/commit/ec12eb659d8c8e78ad4bb15d1a941ac3153a0f66">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=787952">787952</a> - Problem parsing c++ gnu::visibility [<a href="http://github.com/doxygen/doxygen/commit/d8001efd89146e04d92f5ea41ab27a7de09b6c53">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=788209">788209</a> - C++: False warning message when inheriting class from tag file [<a href="http://github.com/doxygen/doxygen/commit/aac84d5624b96d8937ff543ab8724c269b8726ab">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=789007">789007</a> - Error in markdown emphasis examples [<a href="http://github.com/doxygen/doxygen/commit/81956108f2e6e97bf4dd0f1011fcae1b5c4c4408">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=789168">789168</a> - Increasing access of inherited C++ members with 'using...' is not recognized by Doxygen [<a href="http://github.com/doxygen/doxygen/commit/9468ede259153cf79eb8d61635389744e9a2ee7d">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=790320">790320</a> - C++ parameter from lambda not recognized [<a href="http://github.com/doxygen/doxygen/commit/7b43be09e513ea6f86f9ca53ce05c94d63eada4c">view</a>] +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=790788">790788</a> - Doxygen not showing the public, non-static member function [<a href="http://github.com/doxygen/doxygen/commit/137b2e8dd03a98e692c2f6d813b47f19f2c64e5b">view</a>] +<li>CMake: avoid if() around the whole contents of documentation CMakeLists.txt [<a href="http://github.com/doxygen/doxygen/commit/62e87408cb7094eeac130775e62d5b7a6f4a79c9">view</a>] +<li>CMake: avoid if() around the whole contents of plugin CMakeLists.txt [<a href="http://github.com/doxygen/doxygen/commit/7c1c75a2c5583415d178e0e46a1a356bef9b0c84">view</a>] +<li>CMake: let CMake handle the C++ standard setting if target_compile_features() is used [<a href="http://github.com/doxygen/doxygen/commit/ca7e60edd370949cfb2adb83ca0b532bb3fdc441">view</a>] +<li>CMake: let file(MAKE_DIRECTORY) create all directories at once [<a href="http://github.com/doxygen/doxygen/commit/0d7be027a6fea2ac198dded58f8b55cda1bbe962">view</a>] +<li>CMake: remove CUSTOM_(LINK|INCLUDE)_DIR [<a href="http://github.com/doxygen/doxygen/commit/28f09783b1e45a827729abaca61f963dd869381b">view</a>] +<li>CMake: remove needless variable expansions [<a href="http://github.com/doxygen/doxygen/commit/975fb19eb07bc65ef48ddd5f26bf6be2736d0e0a">view</a>] +<li>CMake: remove unused program searching [<a href="http://github.com/doxygen/doxygen/commit/02f726b63e2b3a2ed4c5da43c164dcaad5fcfe94">view</a>] +<li>CMake: search for Qt5 only in config file mode [<a href="http://github.com/doxygen/doxygen/commit/ac5ca4ef86ad50232be75a65fab99302307b7795">view</a>] +<li>CMake: use GNUInstallDirs module for man pages directory [<a href="http://github.com/doxygen/doxygen/commit/fcf5fecb64d5c194430e10cbe52482b14224d645">view</a>] +<li>CMake: use add_test to create a test [<a href="http://github.com/doxygen/doxygen/commit/b54b843accb97105ae4afaf24136e33bfd1ea9d4">view</a>] +<li>CMakeLists: Avoid MSVC iconv changes for MinGW builds [<a href="http://github.com/doxygen/doxygen/commit/9532e0f19532e9d76c3f1092d131af91125a2dff">view</a>] +<li>Call endMemberItem consistently. [<a href="http://github.com/doxygen/doxygen/commit/1aafbbc97bdb643cae8be036f2b9ab569ca7f15e">view</a>] +<li>Change navtree collapsed list icon [<a href="http://github.com/doxygen/doxygen/commit/b3869a3ed82957c1785dc955876885f8b73a020b">view</a>] +<li>Code color of , (comma) together with only in use statement [<a href="http://github.com/doxygen/doxygen/commit/6f7264f4a16f5b1240291c6d33a0e4cc98ba30e4">view</a>] +<li>Corrected small type [<a href="http://github.com/doxygen/doxygen/commit/4360982dbaee9b32973a95ba88290022d0643e10">view</a>] +<li>Correction display of backtick in LaTeX [<a href="http://github.com/doxygen/doxygen/commit/beaa386ca97341e66ad673660c808993240df637">view</a>] +<li>Correction of non reachable links and redirected links in documentation. [<a href="http://github.com/doxygen/doxygen/commit/31cf78d223e52fe078ad9b0651672aeb73926065">view</a>] +<li>Documentation, correct referenced file [<a href="http://github.com/doxygen/doxygen/commit/c93a7c34e7efd5ae1f2c3e4d230e29a333bc237a">view</a>] +<li>Doxygen/VHDLdocgen: [<a href="http://github.com/doxygen/doxygen/commit/77e0cf86eadbec22b81e26e083ffc831240869da">view</a>] +<li>Encode invalid XML characters instead of skipping them. [<a href="http://github.com/doxygen/doxygen/commit/b6a7abf02652b74872b9c676fcfa545e18d9bde7">view</a>] +<li>Expose TOC placeholder in XML output. [<a href="http://github.com/doxygen/doxygen/commit/fe760977e2cb643b94fbf21847e0c81e8a080966">view</a>] +<li>Expose underlying enum type in the XML output. [<a href="http://github.com/doxygen/doxygen/commit/17bceb8f4580535de52d19e8cadf0d088f972bef">view</a>] +<li>Fetch filename property from object instead of hardcoded duplicated string [<a href="http://github.com/doxygen/doxygen/commit/84fd1fecfe2de7b4f8c88e1923ef7d5958dc70b0">view</a>] +<li>Fix C# property initializer parsing [<a href="http://github.com/doxygen/doxygen/commit/14a0bcc74a121525917aefc8c9034e283e94884b">view</a>] +<li>Fix for regression in XML output generation after fixing bug 789168 [<a href="http://github.com/doxygen/doxygen/commit/1a1fdbed64de6ce01959b2e4d0988be823fb6bad">view</a>] +<li>Fix https://bugzilla.gnome.org/show_bug.cgi?id=782583. [<a href="http://github.com/doxygen/doxygen/commit/c87f730fe4bc40f72ed5fa52fe032a7bdf2d549c">view</a>] +<li>Fix minor markup issue in the documentation. [<a href="http://github.com/doxygen/doxygen/commit/b4df85466cf0447d46f311046fc5b3fe062b957f">view</a>] +<li>Fix not initialized pointer when parser is starting on a new file. [<a href="http://github.com/doxygen/doxygen/commit/52fb4cd5bb085960476e0cd256cc81db1370839d">view</a>] +<li>Fix typo [<a href="http://github.com/doxygen/doxygen/commit/d6e9db71645d895450993972ed41406c1cf1fc52">view</a>] +<li>Fix: add missing newline char '\n' [<a href="http://github.com/doxygen/doxygen/commit/856a43cfe08179ebbcebe656262b0229925547c8">view</a>] +<li>Fix: add missing semicolon ';' at end of line [<a href="http://github.com/doxygen/doxygen/commit/507880a0c7ed6029ce7ede2e85d23a9650a3f6bf">view</a>] +<li>Fix: change 'CMakefiles' to 'CMakeFiles' (the 'F' is uppercase) [<a href="http://github.com/doxygen/doxygen/commit/bcc09aa2ba01eff458a00aff853d58ed8213a5da">view</a>] +<li>Fix: perl script regexp to toggle flex debug information [<a href="http://github.com/doxygen/doxygen/commit/b11b19badf4ef7318512c28f448dbecd6a47a715">view</a>] +<li>Fixed problem where automatic line breaking caused missing vertical bars in the parameter table for Latex output. [<a href="http://github.com/doxygen/doxygen/commit/5fc82b2275e202438ac61b070ac5f4be0df792d6">view</a>] +<li>Fixes for cross platform build with new LLVM/CLANG version [<a href="http://github.com/doxygen/doxygen/commit/b0aae61c97966cb9d424b500d7ced5bdf500d8db">view</a>] +<li>Fixup man page NAME section when page has title [<a href="http://github.com/doxygen/doxygen/commit/9d0908359363dbb43236767669c214721700acf7">view</a>] +<li>Function declaration following a function definition incorrectly listed as calling dependencing [<a href="http://github.com/doxygen/doxygen/commit/436fc7ed1158d517dd6f6d25aa3e05568f8c3d94">view</a>] +<li>Further cleanup of lodepng code [<a href="http://github.com/doxygen/doxygen/commit/c627108f3315144f5d9fb84d0197502b939caf7d">view</a>] +<li>Implement "double-space line breaks" syntax in Markdown [<a href="http://github.com/doxygen/doxygen/commit/e4596c7eab90ba4d307e2c212cefeab8ac820269">view</a>] +<li>Improve Chinese translation [<a href="http://github.com/doxygen/doxygen/commit/ded5247523ec8d47129405df3999ce391cca9e2d">view</a>] +<li>Inline attribute got reset for functions returning an explicit struct type [<a href="http://github.com/doxygen/doxygen/commit/127a43d464790dd0312794fe7ae1d92247cd9eef">view</a>] +<li>Isolated none-existing posix threading functions on Android [<a href="http://github.com/doxygen/doxygen/commit/4e25f081847cf2717ad561214e90d9750da5a511">view</a>] +<li>Marks JS as freely licensed [<a href="http://github.com/doxygen/doxygen/commit/6b5617e5a4c87afd2c7f2f7b8cb03de2b6735627">view</a>] +<li>Misc. doxy and comment typos [<a href="http://github.com/doxygen/doxygen/commit/1764f7a0f199b9f2a85f885cfd0f1804f8292c49">view</a>] +<li>Misc. typos [<a href="http://github.com/doxygen/doxygen/commit/9fd7f3aeb4c2e78bda669bf4ef6fff1c12c062a4">view</a>] +<li>New table features mentioned in the documentation were not enabled. [<a href="http://github.com/doxygen/doxygen/commit/c120ac4762331513305e8a19fd9b267b2d4f9e41">view</a>] +<li>Pass strings as const references. [<a href="http://github.com/doxygen/doxygen/commit/ebf75c1fe8a0ff2cc9235155b6d63367944d6342">view</a>] +<li>Physical newlines in ALIASES configuration tags. [<a href="http://github.com/doxygen/doxygen/commit/d6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd">view</a>] +<li>Propagate language information to all <programlisting> XML elements. [<a href="http://github.com/doxygen/doxygen/commit/eaf8edbac7e6a1873aa5c4ff0df063cd367351d6">view</a>] +<li>Properly copy images for the XML output. [<a href="http://github.com/doxygen/doxygen/commit/507dd0a60dd12c61ff2088db419187efc928c010">view</a>] +<li>Provide dot path to plantuml [<a href="http://github.com/doxygen/doxygen/commit/c24cb9a74ef0af854455047f29f9925d79ac0195">view</a>] +<li>Provide information about enum type "strongness" in the XML output. [<a href="http://github.com/doxygen/doxygen/commit/169cad806ea795e5c425fd397aa0de54cbc0a81e">view</a>] +<li>Provide page brief in <briefdescription> of XML output. [<a href="http://github.com/doxygen/doxygen/commit/bd2cf98e75c600e0c2f5ae95301df8745d65571a">view</a>] +<li>Provide template parameters also for type aliases in the XML output. [<a href="http://github.com/doxygen/doxygen/commit/21f0ca0085c034a37df07c1ab690472bada0a1f1">view</a>] +<li>Removed -Wno-deprecated flag from bison as it is not support on the bison 2.3 that ships with XCode [<a href="http://github.com/doxygen/doxygen/commit/6c288bf0e7548117aa358719aaecffedcc579590">view</a>] +<li>Restore 'make tests' rule [<a href="http://github.com/doxygen/doxygen/commit/7ce59c9fbd5e99619a9ab0ac6177d21e6aca49c7">view</a>] +<li>Restore Makefile in vhdlparser dir [<a href="http://github.com/doxygen/doxygen/commit/aee944fe954de993a4273fafef6b5f0c726be7f3">view</a>] +<li>Spelling correction [<a href="http://github.com/doxygen/doxygen/commit/4cca51612a50a9016be5adbd6ccdc26c03d12b58">view</a>] +<li>Stripped unused LodePNG code to prevent false positives for coverity [<a href="http://github.com/doxygen/doxygen/commit/64865ad3e91fffe6e50b51b29ae2a54126f80126">view</a>] +<li>Suppresses warning for XML <see langword="..."/> [<a href="http://github.com/doxygen/doxygen/commit/a3c5958b437b5dc9de91de5f40917ec53532b60a">view</a>] +<li>Suppression warnings about deprecated directive [<a href="http://github.com/doxygen/doxygen/commit/cd0faad90e9b6ce83fa1f7b4fb27a39357b0cae3">view</a>] +<li>Update .travis.yml [<a href="http://github.com/doxygen/doxygen/commit/5f028fd744526148aace4c971f739c9876b6108a">view</a>] +, [<a href="http://github.com/doxygen/doxygen/commit/b7fc8a384b091f5761159d263ec27e30c3160a50">view</a>] +<li>Update mathjax path [<a href="http://github.com/doxygen/doxygen/commit/57e69ba26eff5eac4b31b088cd7d3dfa7532f12c">view</a>] +<li>Updated translator_de.h to doxygen 1.8.13 [<a href="http://github.com/doxygen/doxygen/commit/a9e3d5378ffbef542045d04239482bd6fec33e15">view</a>] +<li>Use hidden symbol visibility by default [<a href="http://github.com/doxygen/doxygen/commit/dcb3b2d0b888902a062eefd8200ea194ed1c42d6">view</a>] +<li>Use language identifier instead of file extension for language attribute [<a href="http://github.com/doxygen/doxygen/commit/ed9acb6e1bb81a2eec334180f7b8c1bf0598b444">view</a>] +<li>Use language in stead of lang for language name attribute [<a href="http://github.com/doxygen/doxygen/commit/4e4741221f4290412ef4a6b6bbfe9799abafaf6c">view</a>] +<li>Update of the Brazillian translation [<a href="http://github.com/doxygen/doxygen/commit/d283dfcdcaa0837e84d7995676d436fa04e96d1f">view</a>] +<li>[preprocessing.doc] typo amended [<a href="http://github.com/doxygen/doxygen/commit/6b67a64bd0bd1c6759294c323433dbd7d37df6ac">view</a>] +<li>add decimal to base identifier [<a href="http://github.com/doxygen/doxygen/commit/9cbc1a04e584e83d91ff3f7501f38b0a825e1953">view</a>] +<li>add the number of conditionals path and bugfix [<a href="http://github.com/doxygen/doxygen/commit/20af63f43e583a31dfe93f78807aa868f9b9ff14">view</a>] +<li>build: fix the way lang_cfg.h is generated [<a href="http://github.com/doxygen/doxygen/commit/cc3a9e611c15f32ae4913a87306699db60758245">view</a> and <a href="http://github.com/doxygen/doxygen/commit/a4b6f59e0c99457ba8f4f71782e51d50b7a1057f">view</a>] +<li>bump version number for the development version/next release [<a href="http://github.com/doxygen/doxygen/commit/0a6d8bf6f5ef3a537de6ab517d0ae9c4f5d558d0">view</a>] +<li>const-ify [<a href="http://github.com/doxygen/doxygen/commit/5df4341210ec2374b8b7c09f5df3cd8f4ff60f65">view</a>] +<li>dot.cpp: Fix DotGfxHierarchyTable first class node loop [<a href="http://github.com/doxygen/doxygen/commit/c7348b4483ace9b5608fbbe949eab02921eb0e70">view</a>] +<li>fix spelling [<a href="http://github.com/doxygen/doxygen/commit/bca94d6ca30bde5f01dd17a83cfa63268c0ca664">view</a>] +<li>fix test to support new programlisting attribute [<a href="http://github.com/doxygen/doxygen/commit/a9963fd94acd5839e818890b6a356d6b335c1f74">view</a>] +<li>fix typo [<a href="http://github.com/doxygen/doxygen/commit/f88ebaf9f23c3151f312400d77150eeeeb8158c2">view</a>] +<li>fixes vhdl literal bug [<a href="http://github.com/doxygen/doxygen/commit/6c387a6be9128ced0b89f6fc75946cd1a85096fb">view</a>] +<li>line continuation characters inside comments embedded in a macro definition appeared in the output [<a href="http://github.com/doxygen/doxygen/commit/898b6044194d5967099adfadab454cd09a4f360e">view</a>] +<li>make use of clang compilation database [<a href="http://github.com/doxygen/doxygen/commit/818aefcecf3cca986c971cd236bd7b77337db955">view</a>] +<li>new addon doxyparse, a source parsing engine [<a href="http://github.com/doxygen/doxygen/commit/e6dcc3b6c6dd449800eeebc172c1d15367d61d74">view</a>] +<li>sqlite3gen: add index on params [<a href="http://github.com/doxygen/doxygen/commit/3b3d1edeacde99719456b8f1616077707a5a2012">view</a>] +<li>sqlite3gen: add missing protectedsettable column [<a href="http://github.com/doxygen/doxygen/commit/ba8e4323290da4cb6de59060c77fe02a4df694b4">view</a>] +<li>sqlite3gen: add openDbConnection [<a href="http://github.com/doxygen/doxygen/commit/5596fcd158e7c53638324cea8ba3da31b2c32620">view</a>] +<li>sqlite3gen: start checking operations status [<a href="http://github.com/doxygen/doxygen/commit/74cebdbbbc2c267c254ab2c337ee06250ab8424d">view</a>] +<li>sqlite3gen: use sqlite3_exec for schema setup [<a href="http://github.com/doxygen/doxygen/commit/1ec8f0eb9169fc3f9ab82b60712a332bf60728bf">view</a>] +<li>typos [<a href="http://github.com/doxygen/doxygen/commit/5711b54b4813a2f4ce3b858e496ac846cbda69e5">view</a>] +<li>update compound.xsd to add language attribute [<a href="http://github.com/doxygen/doxygen/commit/0259d2a8bf9571e06873b80df96fd2ff29723dbc">view</a>] +<li>using YAML in the output of "doxyparse" [<a href="http://github.com/doxygen/doxygen/commit/82dbb5fe863e13175eda130dcc728b102101ccda">view</a>] +</ul> +<p> +\endhtmlonly + \subsection log_1_8_13 Release 1.8.13 \htmlonly <b>(release date 29-12-2016)</b> diff --git a/doc/commands.doc b/doc/commands.doc index 6cb7a4d..12b85db 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -433,7 +433,7 @@ Structural indicators \par Example: \include enum.h \htmlonly - Click <a href="examples/enum/html/class_test.html">here</a> + Click <a href="examples/enum/html/class_enum___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -565,7 +565,7 @@ Structural indicators \par Example: \include func.h \htmlonly - Click <a href="examples/func/html/class_test.html">here</a> + Click <a href="examples/func/html/class_fn___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -823,7 +823,7 @@ Structural indicators \par Example: \include overload.cpp \htmlonly - Click <a href="examples/overload/html/class_test.html">here</a> + Click <a href="examples/overload/html/class_overload___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -1121,7 +1121,7 @@ Structural indicators <hr> \section cmdweakgroup \\weakgroup <name> [(title)] - \addindex \\addtogroup + \addindex \\weakgroup Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has a lower priority when it comes to resolving conflicting grouping definitions. @@ -1513,7 +1513,7 @@ ALIASES = "english=\if english" \ \par Example: \include par.cpp \htmlonly - Click <a href="examples/par/html/class_test.html">here</a> + Click <a href="examples/par/html/class_par___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -2120,8 +2120,8 @@ Commands for displaying examples \par Example: \include include.cpp - Where the example file \c example_test.cpp looks as follows: - \include example_test.cpp + Where the example file \c include_test.cpp looks as follows: + \include include_test.cpp \htmlonly Click <a href="examples/include/html/example.html">here</a> for the corresponding HTML documentation that is generated by doxygen. @@ -2197,7 +2197,7 @@ Commands for displaying examples \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with this command due to the moment of parsing. - \note The included documentation should not have comment signs in it as the will appear + \note The included documentation should not have comment signs in it as they will appear in the documentation as well. \sa section \ref cmdinclude "\\include". @@ -2325,7 +2325,7 @@ Commands for displaying examples \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with this command due to the moment of parsing. - \note The included documentation should not have comment signs in it as the will appear + \note The included documentation should not have comment signs in it as they will appear in the documentation as well. \sa section \ref cmdsnippet "\\snippet" and \ref cmdincludedoc "\\includedoc". @@ -2704,7 +2704,7 @@ class Receiver \addindex \\startuml Starts a text fragment which should contain a valid description of a - PlantUML diagram. See http://plantuml.sourceforge.net/ for examples. + PlantUML diagram. See http://plantuml.com/ for examples. The text fragment ends with \ref cmdenduml "\\enduml". \note You need to install Java and the PlantUML's jar file, if you want to use this command. The location of the jar file should be specified @@ -3317,7 +3317,7 @@ class Receiver \addindex \\\% This command writes the \c \% character to the output. This character has to be escaped in some cases, because it is used to - prevent auto-linking to word that is also a documented class or struct. + prevent auto-linking to a word that is also a documented class or struct. <hr> \section cmdquot \\" diff --git a/doc/custcmd.doc b/doc/custcmd.doc index 8ac2a65..de9a30d 100644 --- a/doc/custcmd.doc +++ b/doc/custcmd.doc @@ -40,7 +40,9 @@ The simplest form of an alias is a simple substitution of the form put the command `\sideeffect` (or `@sideeffect`) in the documentation, which will result in a user-defined paragraph with heading <b>Side Effects:</b>. -Note that you can put `\n`'s in the value part of an alias to insert newlines. +Note that you can put `\n`'s in the value part of an alias to insert newlines +(in the resulting output). You can put `^^` in the value part of an alias to +insert a newline as if a physical newline was in the original file. Also note that you can redefine existing special commands if you wish. diff --git a/doc/customize.doc b/doc/customize.doc index f98ce0b..9ef3891 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -90,7 +90,7 @@ that are disabled by default: To tweak things like fonts or colors, margins, or other look \& feel aspects of the HTML output in detail, you can create a different -<a href="http://www.w3schools.com/css/default.asp">cascading style sheet</a>. +<a href="https://www.w3schools.com/css/default.asp">cascading style sheet</a>. You can also let doxygen use a custom header and footer for each HTML page it generates, for instance to make the output conform to the style used on the rest of your web site. @@ -390,7 +390,7 @@ files as one big DOM tree would not fit into memory. See <a href="https://github.com/michaeljones/breathe">the Breathe project</a> for an example that uses doxygen XML output from Python to bridge it with the -<a href="http://sphinx.pocoo.org/">Sphinx</a> document generator. +<a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> document generator. \htmlonly diff --git a/doc/docblocks.doc b/doc/docblocks.doc index f0499c6..81cfdd0 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -260,7 +260,7 @@ Here is an example of the use of these comment blocks: \include afterdoc.h \htmlonly </p> - Click <a href="examples/afterdoc/html/class_test.html">here</a> + Click <a href="examples/afterdoc/html/class_afterdoc___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -281,7 +281,7 @@ Here is an example of a documented piece of C++ code using the Qt style: \include qtstyle.cpp \htmlonly </p> - Click <a href="examples/qtstyle/html/class_test.html">here</a> + Click <a href="examples/qtstyle/html/class_q_tstyle___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -316,7 +316,7 @@ JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES: \include jdstyle.cpp \htmlonly </p> - Click <a href="examples/jdstyle/html/class_test.html">here</a> + Click <a href="examples/jdstyle/html/class_javadoc___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -634,7 +634,7 @@ need for some more structure, like a block of verbatim text, a list, or a simple table. For this doxygen supports the <a href="http://daringfireball.net/projects/markdown/syntax">Markdown</a> syntax, including parts of the -<a href="http://michelf.com/projects/php-markdown/extra/">Markdown Extra</a> +<a href="https://michelf.ca/projects/php-markdown/extra/">Markdown Extra</a> extension. Markdown is designed to be very easy to read and write. @@ -646,13 +646,13 @@ directly. For more details see chapter \ref markdown. For programming language specific formatting doxygen has two forms of additional markup on top of Markdown formatting. -1. <a href="http://en.wikipedia.org/wiki/Javadoc">Javadoc</a> like markup. +1. <a href="https://en.wikipedia.org/wiki/Javadoc">Javadoc</a> like markup. See \ref commands for a complete overview of all commands supported by doxygen. -2. <a href="http://en.wikipedia.org/wiki/C_Sharp_(programming_language)#XML_documentation_system">XML</a> markup +2. <a href="https://en.wikipedia.org/wiki/C_Sharp_(programming_language)#XML_documentation_system">XML</a> markup as specified in the C# standard. See \ref xmlcmds for the XML commands supported by doxygen. If this is still not enough doxygen also supports a \ref htmlcmds "subset" of -the <a href="http://en.wikipedia.org/wiki/HTML">HTML</a> markup language. +the <a href="https://en.wikipedia.org/wiki/HTML">HTML</a> markup language. \htmlonly Go to the <a href="markdown.html">next</a> section or return to the diff --git a/doc/extsearch.doc b/doc/extsearch.doc index cead851..99a7219 100644 --- a/doc/extsearch.doc +++ b/doc/extsearch.doc @@ -52,7 +52,7 @@ The data flow is shown in the following diagram: The first step is to make the search engine available via a web server. If you use `doxysearch.cgi` this means making the -<a href="http://en.wikipedia.org/wiki/Common_Gateway_Interface">CGI</a> binary +<a href="https://en.wikipedia.org/wiki/Common_Gateway_Interface">CGI</a> binary available from the web server (i.e. be able to run it from a browser via an URL starting with http:) @@ -187,7 +187,7 @@ The next subsections describe these interfaces in more detail. \subsection extsearch_api_index Indexer input format The search data produced by doxygen follows the -<a href="http://wiki.apache.org/solr/UpdateXmlMessages">Solr XML index message</a> +<a href="https://wiki.apache.org/solr/UpdateXmlMessages">Solr XML index message</a> format. The input for the indexer is an XML file, which consists of one `<add>` tag containing @@ -224,12 +224,12 @@ Each field has a name. The following field names are supported: - *text*: the documentation associated with the item. Note that only words are present, no markup. @note Due to the potentially large size of the XML file, it is recommended to use a -<a href="http://en.wikipedia.org/wiki/Simple_API_for_XML">SAX based parser</a> to process it. +<a href="https://en.wikipedia.org/wiki/Simple_API_for_XML">SAX based parser</a> to process it. \subsection extsearch_api_search_in Search URL format When the search engine is invoked from a doxygen generated HTML page, a number of parameters are -passed to via the <a href="http://en.wikipedia.org/wiki/Query_string">query string</a>. +passed to via the <a href="https://en.wikipedia.org/wiki/Query_string">query string</a>. The following fields are passed: - *q*: the query text as entered by the user @@ -247,14 +247,14 @@ It represents a query for the word 'list' (`q=list`) requesting 20 search result starting with the result number 20 (`p=1`) and using callback 'dummy' (`cb=dummy`): -@note The values are <a href="http://en.wikipedia.org/wiki/Percent-encoding">URL encoded</a> so they +@note The values are <a href="https://en.wikipedia.org/wiki/Percent-encoding">URL encoded</a> so they have to be decoded before they can be used. \subsection extsearch_api_search_out Search results format When invoking the search engine as shown in the previous subsection, it should reply with the results. The format of the reply is -<a href="http://en.wikipedia.org/wiki/JSONP">JSON with padding</a>, which is basically +<a href="https://en.wikipedia.org/wiki/JSONP">JSON with padding</a>, which is basically a javascript struct wrapped in a function call. The name of function should be the name of the callback (as passed with the *cb* field in the query). diff --git a/doc/faq.doc b/doc/faq.doc index 5af3db8..bbad8c0 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -285,7 +285,7 @@ At the time I was looking into \c lex and \c yacc, where a lot of things start w \section faq_why What was the reason to develop doxygen? I once wrote a GUI widget based on the Qt library (it is still available at -http://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002). +https://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002). Qt had nicely generated documentation (using an internal tool which <a href="http://rant.gulbrandsen.priv.no/udoc/history">they didn't want to release</a>) and I wrote similar docs by hand. diff --git a/doc/formulas.doc b/doc/formulas.doc index 650751e..1649c19 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -30,7 +30,7 @@ have the following tools installed to bitmaps. I have used Aladdin GhostScript 8.0 for testing. </ul> For the HTML output there is also an alternative solution using -<a href="http://www.mathjax.org">MathJax</a> which does not +<a href="https://www.mathjax.org">MathJax</a> which does not require the above tools. If you enable \ref cfg_use_mathjax "USE_MATHJAX" in the config then the latex formulas will be copied to the HTML "as is" and a client side javascript will parse them and turn them into (interactive) images. diff --git a/doc/grouping.doc b/doc/grouping.doc index bbb577c..2c4ebe1 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -197,7 +197,7 @@ documentation of the class. \htmlonly </p> -Click <a href="examples/memgrp/html/class_test.html">here</a> +Click <a href="examples/memgrp/html/class_memgrp___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly diff --git a/doc/index.doc b/doc/index.doc index c8950c4..14f0396 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -180,7 +180,7 @@ Thanks go to: <li>Talin for adding support for C# style comments with XML markup. <li>Petr Prikryl for coordinating the internationalization support. All language maintainers for providing translations into many languages. -<li>The band <a href="http://www.porcupinetree.com">Porcupine Tree</a> for +<li>The band <a href="http://www.porcupinetree.com/">Porcupine Tree</a> for providing hours of great music to listen to while coding. <li>many, many others for suggestions, patches and bug reports. </ul> diff --git a/doc/install.doc b/doc/install.doc index fd4f28d..6db8102 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -37,7 +37,7 @@ following to build the executable: \addindex strip \addindex python <li>In order to generate a \c Makefile for your platform, you need - <a href="http://www.cmake.org/">cmake</a> version 2.8.12 or later. + <a href="https://cmake.org/">cmake</a> version 2.8.12 or later. \addindex cmake </ul> @@ -61,9 +61,9 @@ tools should be installed. freetype support (which requires the freetype library and header files), otherwise the graphs will not render proper text labels. <li>For formulas in the HTML output (when MathJax is not used) - or in case you do not wish to use `pdflatex, + or in case you do not wish to use `pdflatex`, the ghostscript interpreter is needed. You can find it at - <a href="http://www.ghostscript.com/">www.ghostscript.com</a>. + <a href="https://www.ghostscript.com/">www.ghostscript.com</a>. </ul> Compilation is now done by performing the following steps: @@ -150,20 +150,20 @@ standard installation procedure that is required for these packages. \section install_src_windows Compiling from source on Windows From version 1.8.10 onwards, build files need to be generated by cmake. -cmake can be downloaded from http://www.cmake.org/download/ +cmake can be downloaded from https://cmake.org/download/ At the moment only the express version of Visual Studio 2013 is tested, but other version might also work. Alternatively, you can compile doxygen \ref install_src_unix "the UNIX way" using -<a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a> +<a href="https://en.wikipedia.org/wiki/Cygwin">Cygwin</a> or <a href="http://www.mingw.org/">MinGW</a>. The next step is to install modern versions of \c bison and \c flex -(see http://sourceforge.net/projects/winflexbison. After installation and adding them to +(see https://sourceforge.net/projects/winflexbison/. After installation and adding them to your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`) -Furthermore you have to install \c python (version 2.6 or higher, see http://www.python.org). +Furthermore you have to install \c python (version 2.6 or higher, see https://www.python.org). These packages are needed during the compilation process. Download doxygen's source tarball and put it somewhere (e.g. use <code>c:\\tools</code>) @@ -214,19 +214,19 @@ you need qhelpgenerator which is part of Qt. You can download Qt from <a href="http://qt-project.org/downloads">Qt Software Downloads</a>. In order to generate PDF output or use scientific formulas you will also need to -install <a href="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and -<a href="http://en.wikipedia.org/wiki/Ghostscript">Ghostscript</a>. +install <a href="https://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and +<a href="https://en.wikipedia.org/wiki/Ghostscript">Ghostscript</a>. For \LaTeX a number of distributions exists. Popular ones that should work with -doxygen are <a href="http://www.miktex.org">MikTex</a> +doxygen are <a href="https://miktex.org/">MikTex</a> and <a href="http://www.tug.org/protext/">proTeXt</a>. -Ghostscript can be <a href="http://sourceforge.net/projects/ghostscript/">downloaded</a> +Ghostscript can be <a href="https://sourceforge.net/projects/ghostscript/">downloaded</a> from Sourceforge. After installing \LaTeX and Ghostscript you'll need to make sure the tools latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a -command box. Follow <a href="http://www.computerhope.com/issues/ch000549.htm">these</a> +command box. Follow <a href="https://www.computerhope.com/issues/ch000549.htm">these</a> instructions if you are unsure and run the commands from a command box to verify it works. \htmlonly diff --git a/doc/language.tpl b/doc/language.tpl index 01d906b..9e334c6 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -24,8 +24,10 @@ change the language.doc, make the changes here and inside maintainers.txt. Doxygen has built-in support for multiple languages. This means that the text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the -configuration option \ref cfg_output_language "OUTPUT_LANGUAGE" in the -configuration file (with default name and known as Doxyfile). +configuration option \ref cfg_output_language "OUTPUT_LANGUAGE" in the +configuration file (with default name and known as Doxyfile). To switch +between languages inside a comment block the \ref cmdtilde "\\~" command +can be used. Currently (version %(doxVersion)s), %(numLangStr)s languages are supported (sorted alphabetically): diff --git a/doc/markdown.doc b/doc/markdown.doc index 300d7fc..e5aebd1 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -41,9 +41,9 @@ the extensions that doxygen supports. Finally section \ref markdown_dox discusses some specifics for doxygen's implementation of the Markdown standard. -[markdown]: http://daringfireball.net/projects/markdown -[mdextra]: http://michelf.com/projects/php-markdown/extra/ -[github]: http://github.github.com/github-flavored-markdown/ +[markdown]: http://daringfireball.net/projects/markdown/ +[mdextra]: https://michelf.ca/projects/php-markdown/extra/ +[github]: https://github.github.com/github-flavored-markdown/ \section markdown_std Standard Markdown @@ -164,13 +164,13 @@ Using two stars or underscores will produce strong emphasis. Examples: - *single asterisks* - - _single underscores_ - - **double asterisks** - - __double underscores__ +* *single asterisks* +* +* _single underscores_ +* +* **double asterisks** +* +* __double underscores__ See section \ref mddox_emph_spans for more info how doxygen handles emphasis spans slightly different than standard Markdown. @@ -303,7 +303,7 @@ Note that using `[TOC]` is the same as using a \subsection md_tables Tables Of the features defined by "Markdown Extra" is support for -<a href="http://michelf.com/projects/php-markdown/extra/#table">simple tables</a>: +<a href="https://michelf.ca/projects/php-markdown/extra/#table">simple tables</a>: A table consists of a header line, a separator line, and at least one row line. Table columns are separated by the pipe (|) character. @@ -376,7 +376,7 @@ For more complex tables in doxygen please have a look at: \ref tables \subsection md_fenced Fenced Code Blocks Another feature defined by "Markdown Extra" is support for -<a href="http://michelf.com/projects/php-markdown/extra/#fenced-code-blocks"> +<a href="https://michelf.ca/projects/php-markdown/extra/#fenced-code-blocks"> fenced code blocks</a>: A fenced code block does not require indentation, and is diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index d62bbb3..30d4cf3 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -62,7 +62,7 @@ to \c YES. Then the result after preprocessing becomes: #define VERSION #define CONST_STRING - static const char * version = "1.xx"; + static const char * version = "2.xx"; \endverbatim Note that doxygen will now expand \e all macro definitions diff --git a/doc/searching.doc b/doc/searching.doc index dcf858f..00c6141 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -72,7 +72,7 @@ has its own advantages and disadvantages: searching, meaning that you could use your own indexer and search engine of choice. To make life easier doxygen ships with an example indexer (doxyindexer) and search engine (doxysearch.cgi) based on - the <a href="http://xapian.org/">Xapian</a> open source search engine + the <a href="https://xapian.org/">Xapian</a> open source search engine library. To enable this search method set @@ -147,7 +147,7 @@ has its own advantages and disadvantages: \ref cfg_qhp_namespace "QHP_NAMESPACE", \ref cfg_qhg_location "QHG_LOCATION", \ref cfg_qhp_virtual_folder "QHP_VIRTUAL_FOLDER". - See <a href="http://doc.qt.digia.com/qq/qq28-qthelp.html#htmlfilesandhelpprojects">this article</a> + See <a href="http://doc.qt.io/archives/qq/qq28-qthelp.html#htmlfilesandhelpprojects">this article</a> for more info. Feature wise the Qt compressed help feature is comparable with the CHM diff --git a/doc/starting.doc b/doc/starting.doc index bfb8e8f..c869867 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -263,7 +263,7 @@ capabilities of the man page format, so some information \subsection docbook_out DocBook output \addindex docbook Doxygen can also generate output in the -<a href="http://www.docbook.org/">DocBook</a> format. How to process the +<a href="http://docbook.org/">DocBook</a> format. How to process the DocBook output is beyond the scope of this manual. \section step3 Step 3: Documenting the sources |