summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doxygen manual top rule is in uppercase.albert-github2020-12-221-6/+6
| | | | | | When generating the doxygen documentation we see that:: - the top rule is completely in uppercase (is OK in regular doxygen documentation) - the renew of the was done at the wrong place
* Doxygen's own documentation doesn't build with recent LaTeX versionalbert-github2020-12-191-27/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | Due to a recent change in the new distribution of LaTeX in the handling of the "input" commands we get the error like: ``` Appendix D. (../html/examples/group/latex/refman_doc.tex (../html/examples/group/latex//gro up__group1.tex) [243] ! I can't write on file `../html/examples/group/latex//group__group2.aux'. \@include ...mmediate \openout \@partaux "#1.aux" \immediate \write \@partau... l.3 \include{group__group2} Please type another output file name ! Emergency stop. \@include ...mmediate \openout \@partaux "#1.aux" \immediate \write \@partau... l.3 \include{group__group2} *** (job aborted, file error in nonstop mode) ``` The problem is that now an intermediate file is written to `../html/examples/group/latex//group__group2.aux` that was written in the older distributions as `./group__group2.aux`, so in the current directory. Writing to sub directories of the current directory is possible but it is not allowed (unless special, dangerous, options are used) to write to directories outside tgese directories. (see also: https://tex.stackexchange.com/questions/575120/problem-writing-aux-file) This fix writes the examples in subdirectories in the latex directory and not under the, parallel, html directory. This means also that there is a cleaner and clearer distinction between the html and latex output.
* Present all warnings of first documentation sub-task when it failsalbert-github2020-12-041-1/+1
| | | | | This is a follow-up on pull request #8199 (Have build of doxygen documentation fail on warnings.) and #8197 (issue #8023 Add option to exit with non-zero exit code on warnings even if WARN_AS_ERROR is OFF). These were 2 independent situation, but as with #8197 incor[porated into doxygen it is no possible to extend #8199 to fail but at present all warnings of the first (sub-)task that fails.
* Merge pull request #8199 from albert-github/feature/bug_docu_failDimitri van Heesch2020-12-031-0/+1
|\ | | | | Have build of doxygen documentation fail on warnings.
| * Have build of doxygen documentation fail on warnings.albert-github2020-11-241-0/+1
| | | | | | | | | | Currently when running doxygen to create its documentation no error is given when a warning is generated, so the warning might go unnoticed. By setting `WARN_AS_ERROR = YES` the generation will stop and when build on CI systems a build also fails
* | Incorrect link in doxygen documentationalbert-github2020-12-034-5/+5
| | | | | | | | | | The link to mathjax is not correct anymore (config.xml), the latest version points to version 3.0 and here there is no output.html either. Setting it fixed to the 2.7 version. The other corrected links are just about redirections that are otherwise done.
* | fix: convert links to the main doxygen site to https. Trailing whitespace ↵Allan Bowe2020-11-295-168/+168
| | | | | | | | was also removed (hope this is ok, was a default setting). Closes #8212
* | Merge pull request #8196 from albert-github/feature/bug_shown_filesDimitri van Heesch2020-11-241-1/+3
|\ \ | | | | | | Exclude markdown mapped documentation files from Files list
| * | Exclude markdown mapped documentation files from Files listalbert-github2020-11-241-1/+3
| |/ | | | | | | Update of documentation
* | Merge pull request #8198 from albert-github/feature/bug_dot_cleanupDimitri van Heesch2020-11-241-0/+9
|\ \ | | | | | | Making the use of DOT_CLEANUP more transparent
| * | Making the use of DOT_CLEANUP more transparentalbert-github2020-11-231-0/+9
| |/ | | | | | | | | - The setting `DOT_CLEANUP` is not only used for `dot` files but also for temporary `msc` and `plantuml` files, though this was not clear from the documentation. - For the docbook output format the removal of the `dot` and `msc` files was not don like in the output formats html / LatTeX / rtf.
* | issue #8184 Bad parsing of CMakeLists.txtalbert-github2020-11-241-2/+6
|/ | | | | | - Removing the `txt` and `doc` extension from the default list of `FILE_PATTERNS - Updating documentation - Incorrect parsing for the doxywizard of some \ref items (i.e. when the description contains a space, made compatible again with that happens in configgen.py).
* Missing commands in list of commands documentationalbert-github2020-11-171-0/+2
| | | | | | | | | At the top of the chapter describing the commands there is a list with described commands, here the commands: ``` \noop \static ``` were missing.
* Fix chmod permissions for imagesDimitri van Heesch2020-11-1422-0/+0
|
* Changed some wording.Dimitri van Heesch2020-11-141-123/+124
|
* Update of doxywizard documetationalbert-github2020-11-0927-80/+255
| | | | Bringing the doxywizard documentation up to date with the current version.
* Syntax for faq about use in Windows Powershellalbert-github2020-11-061-1/+6
| | | | The syntax of the Windows Powershell differs from other shells, so an example is added to the faq section
* issue #8160 Example in documentation of ALIASES shows using `\n` instead of `^^`albert-github2020-11-051-1/+1
| | | | Small correction in documentation.
* Incomplete documentation in respect to hyphens for horizontal rulersalbert-github2020-10-181-1/+4
| | | | | In case of a sequence of hyphens the documentation was incomplete. (found during implementation of "Miscounting in markdown in case of a horizontal ruler", #8115)
* 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
| |
generated by cgit v0.12 at 2024-07-08 10:13:48 (GMT)