summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #8099 from albert-github/feature/bug_warn_latex_figDimitri van Heesch2020-10-151-7/+0
|\ | | | | Warning about duplicate figure numbers in LaTeX
| * Warning about duplicate figure numbers in LaTeXalbert-github2020-10-141-7/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In the log file of the generated doxygen manual we see warnings like: ``` pdfTeX warning (ext4): destination with the same identifier (name{figure.22.1}) has been already used, duplicate ignored \AtBegShi@Output ...ipout \box \AtBeginShipoutBox \fi \fi ``` (this pull request was also triggered by: https://stackoverflow.com/questions/64328597/pdftex-warning-saying-about-duplicate-figures) The solution is found by means of: https://tex.stackexchange.com/questions/566677/multiple-use-of-figure-number-ext4-warning/ in short: > The hyperref package patches \caption so \H@refstepcounter is used instead of \refstepcounter. The definition isn't necessary in `manual.sty` as the `doxygen_manual.tex` includes `doxygen.sty`
* | Space around images in LaTeX output is sometimes a bit largealbert-github2020-10-141-0/+1
|/ | | | | | | | When we look at images in documents we see for a number of images a big amount of white space around the image. This is e.g. the case in the doxygen manual at page 99 of the 1.8.20 version. - using `\raggedbottom` sees to it that the space inside the page is removed (there might be some white space when the next image doesn't fit anymore. (See https://tex.stackexchange.com/questions/566779/placing-figures-on-a-fixed-place-without-lot-of-space-around-it) - use `\centering` instead of `\begin{center}` as the center environment adds some extra white space (see a comment with the question, on a different subject though: https://stackoverflow.com/questions/64328597/pdftex-warning-saying-about-duplicate-figures#comment113772445_64328597)
* Missing footer on first page of each chapter in LaTeXalbert-github2020-10-092-13/+23
| | | | | | | | | | | | | | In the doxygen pdf manual we see that on the first page of each chapter the footer is missing, the same occurs in the "normal" documentation generated by doxygen. References: - https://tex.stackexchange.com/questions/566034/footer-ruler-on-first-page-in-fancyhdr-with-book - https://tex.stackexchange.com/questions/566056/footer-ruler-on-first-page-in-fancyhdr-with-book-but-not-in-part-part/ Code changes ("normal" documentation): - latexgen.cpp changes required for the "normal" documentation Code changes (doxygen manual) - doxygen_manual.sty, remove word "Part" for the Appendices. - manual.sty changes like for "normal" documentation plus patching part in case of the `\part` (here we don't want the footer or header)
* Mismatch documentation and build systemalbert-github2020-09-201-6/+6
| | | | | | | | | Looks like the documentation update after > Commit: 10787eed95266bb1a13c892fe4cf5a695dac1559 [10787ee] > Date: Friday, May 15, 2020 11:28:16 AM > Refactoring has not been done.
* Allow building doxygen as a subprojectAnonymous Maarten2020-09-161-13/+13
|
* Consistency in documentation of used Python versionsalbert-github2020-09-042-4/+4
| | | | | | At some places Python version 2.6 was still mentioned, made uniform to 2.7 everywhere. (Is already a bit dubious as of January 1st, 2020 Python 2.7 will reached the end of its life., but still a lot will have Python 2.7 by default).
* Updated changelogRelease_1_8_20Dimitri van Heesch2020-08-241-0/+29
|
* Spelling correctionalbert-github2020-08-161-1/+1
| | | | Small spelling correction as found by spellcheck through Fossies
* Building documentation after changing language filesalbert-github2020-08-163-39/+28
| | | | | | | | | - make `GLOB` for language files consistent with `GLOB` usage in e.g. `src` - make building of `language.doc ` depending on the language files as well - don't copy translator and other input files and handle this also in translator.py - update documentation (Found after Swedish language was updated and tried to build documentation on a non new directory)
* Merge pull request #7575 from albert-github/feature/bug_py_docstrDimitri van Heesch2020-08-101-3/+7
|\ | | | | Using Python docstrings
| * Using Python docstringsalbert-github2020-02-071-3/+7
| | | | | | | | | | - making documentation a bit clearer - add configuration setting to have docstrings not as preformatted text but as normal documentation (default remains preformatted).
* | HTML errors in change logalbert-github2020-08-091-1/+2
| | | | | | | | There were a few logical errors in the changelog , corrected.
* | Added changelog for 1.8.19Release_1_8_19Dimitri van Heesch2020-08-081-0/+181
| |
* | Updated the logo in the manualDimitri van Heesch2020-08-088-6371/+73
| |
* | Additional tweaks to get markdown tables inside ALIASES workDimitri van Heesch2020-07-271-13/+13
| | | | | | | | | | | | | | | | | | | | - Changed \_linebr to \ilinebr - \ilinebr is now also passed to doctokenizer - Also fixes issue #7493 regarding \snippet inside markdown tables and dealing with wrong line on issues detected by docparser after a markdown table. - Added function tracing to markdown (enabled with -d markdown in a debug build)
* | XML tags moved to Appendix D of Ecma-334David Dyck2020-06-161-1/+1
| | | | | | | | | | | | | | The 5th Edition / December 2017 of https://www.ecma-international.org/publications/files/ECMA-ST/ECMA-334.pdf has the XML commands in Appendix D Fix issue Typo in xmlcmds.doc XML tags moved to Appendix D of Ecma-334 #7855 https://github.com/doxygen/doxygen/issues/7855
* | issue #7810 LaTeX manual not built, but make install tries to install it (#7821)albert-github2020-06-131-0/+10
| | | | | | | | Give a meaningful fatal error when the pdf does not exists (when it exists automatically also the html directory with content exists). Give a meaningful fatal error when the chm does not exists.
* | Create link for GENERATE_XML (#7824)albert-github2020-06-131-1/+2
| | | | | | Small documentation consistency.
* | Minor documentation updatesDimitri van Heesch2020-06-065-64/+697
| |
* | Update installation documentation for Linux binary distributionDimitri van Heesch2020-06-011-49/+39
| |
* | Merge pull request #7682 from rezarastak/patch-3Dimitri van Heesch2020-05-101-1/+1
|\ \ | | | | | | Link fixed in documentation
| * | Link fixed in documentationReza Rastak2020-04-021-1/+1
| | |
* | | Users cannot set "enhancement label" on github. (#7744)albert-github2020-05-021-2/+1
| | | | | | | | | Normal users of github cannot set labels to issues.
* | | Updated changelog for version 1.8.18Dimitri van Heesch2020-04-121-1273/+1443
|/ /
* | Minor fix for formulas.docReza Rastak2020-03-301-2/+1
| |
* | issue #7674: Mention EXTRACT_ALL in the context of /fileDimitri van Heesch2020-03-301-49/+49
| |
* | Mention EXTRACT_ALL in the context of /fileMoshe Kaplan2020-03-291-1/+2
| |
* | Documentation correction due to removal of Tclalbert-github2020-03-232-2/+3
| | | | | | | | | | - there were still references to Tcl - 2 entries were accidentally removed from the table with fiel extensions.
* | Remove support for TCL (code is too buggy and unmaintained, language not ↵Dimitri van Heesch2020-03-154-75/+4
| | | | | | | | very popular)
* | Fixed minor typo (#7637)Adrien Brignon2020-03-131-1/+1
| |
* | issue #7590 Map .f18 filetype to Fortranalbert-github2020-02-141-9/+9
|/ | | | Documentation has to be updated as well
* Bug 779650 - Typo in https://www.stack.nl/~dimitri/doxygen/manual/docblocks.htmlalbert-github2020-01-231-1/+1
| | | | Corrected spelling
* Merge pull request #7506 from albert-github/feature/bug_cmake_examplesDimitri van Heesch2020-01-131-4/+4
|\ | | | | CMake and examples
| * CMake and examplesalbert-github2020-01-121-4/+4
| | | | | | | | | | Making more use of arrays in CMake to create the documentation of examples. Renaming the template/templ example to have a more consistent naming with the other examples.
* | Merge pull request #7489 from albert-github/feature/bug_win_gsDimitri van Heesch2020-01-121-1/+1
|\ \ | |/ |/| Possibility to use gswin64c on Windows
| * Possibility to use gswin64c on Windowsalbert-github2020-01-071-1/+1
| | | | | | | | | | On windows the 32 bit executable is called gswin32c, but for the 64-bit systems also a gswin64c exists. The path is checked for the existing of these executables (with a preference for the 32 bit version).
* | Adding commands `\rtfinclude`, `\docbookinclude`, `\maninclude` and ↵albert-github2020-01-091-6/+71
|/ | | | | | `\xmlinclude` Adding for consistency with `\*only`, `\htmlincclude` and `\latexinclude` the commands: `\rtfinclude`, `\docbookinclude`, `\maninclude` and `\xmlinclude`
* Showing information from all `*only commands in XML outputalbert-github2020-01-051-14/+21
| | | | This fix reverts the changes from #381 (i.e issue #4214 "htmlonly content appears in generated XML output (Origin: bugzilla 646002)", as XML is seen as an output format that can be further processed and therefore should contain all possible information.
* Small spelling correction in change logalbert-github2020-01-031-2/+2
| | | | Small spelling correction in change log
* Fix double ended list in changelog.docDimitri van Heesch2019-12-271-1/+1
|
* Fixed issue with */ in changelog.docRelease_1_8_17Dimitri van Heesch2019-12-271-1/+1
|
* Updated changelog for release-1.8.17Dimitri van Heesch2019-12-271-0/+243
|
* Merge branch 'feature/bug_html_s' of ↵Dimitri van Heesch2019-12-261-0/+2
|\ | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_html_s
| * Adding HTML s tag, XML corrections for other tagsalbert-github2019-08-161-0/+2
| | | | | | | | Added documentation.
* | Merge pull request #7230 from albert-github/feature/bug_formula_macrofileDimitri van Heesch2019-12-251-1/+19
|\ \ | | | | | | Create possibility to define LaTeX commands for formulas
| * | Create possibility to define LaTeX commands for formulasalbert-github2019-08-271-1/+19
| | | | | | | | | | | | | | | | | | To be able to have building bocks for formulas one can create a `\newcommand` (or when one wants to change a command `\renewcommand`). Due to the different handling of LaTeX commands in pure LaTeX code (latex output and formulas converted to images) and MathJax it is necessary to transform LaTeX commands to the MathJax equivalent. This is done in a transparent way by providing the new commands in a file and add this verbatim to the pure LaTeX code and to translate the `\newcommand` and `\renewcomamnd` to MathJax macros.
* | | Merge branch 'master' into spellingDimitri van Heesch2019-12-235-10/+25
|\ \ \
| * \ \ Merge pull request #7209 from albert-github/feature/bug_backtick_quote_mdDimitri van Heesch2019-12-231-1/+6
| |\ \ \ | | | | | | | | | | Warning in case of usage of a single quote in a code span.
| | * | | Warning in case of usage of a single quote in a code span.albert-github2019-08-191-1/+6
| | |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | When we have a single quotes in a codespan we can get the warning: ``` warning: found </c> tag without matching <c> ``` Added the workaround to the documentation.