summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Adjusted the text a bitDimitri van Heesch2021-05-251-95/+94
|
* issue #8563 Link not created and the Doxygen comment is placed in the output ↵albert-github2021-05-241-1/+6
| | | | | | improperly A small warning about the usage of "Putting documentation after members" in case of a define.
* Reintroducing the sidebar layout via new FULL_SIDEBAR option.Dimitri van Heesch2021-05-093-0/+11
| | | | | - This new page layout is only enabled if DISABLE_INDEX=YES, GENERATE_TREEVIEW=YES, and FULL_SIDEBAR=YES.
* Reverted the layout change introduced in ↵Dimitri van Heesch2021-05-091-0/+0
| | | | | | | a9d29861fe6ad3c182d6cded2e3636a20086fc96 - Caused issues with existing projects that customized the page header to add own navigation tabs (e.g. CGAL).
* Optimized the layout in case DISABLE_INDEX=YES and GENERATE_TREEVIEW=YESDimitri van Heesch2021-05-087-21/+33
| | | | | - also illustrated the various layouts in the customization section of the manual to make choosing easier.
* Merge pull request #8509 from albert-github/feature/bug_formula_mjDimitri van Heesch2021-05-013-10/+42
|\ | | | | Problems with some commands in MathJax
| * Merge branch 'master' into feature/bug_formula_mjDimitri van Heesch2021-04-281-1/+5
| |\
| * | Problems with some commands in MathJaxalbert-github2021-04-203-10/+42
| | | | | | | | | | | | | | | Especially with commands like `\f$\mbox{\LaTeX}\f$`MathJax has some problem as it is not, yet, able to use the commands `\raise` and `lower` inside the `\mbox` as used in this LaTeX command. Also switching in and out of math-mode doesn't work as the resulting code either doesn't work in MathJax or in LaTeX, hence the new command s `\f(` and `\f)`.
* | | Spelling correctionalbert-github2021-05-011-1/+1
| | | | | | | | | | | | Small spelling correction
* | | Merge branch 'feature/bug_startuml' of ↵Dimitri van Heesch2021-05-011-5/+17
|\ \ \ | | | | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_startuml
| * | | Extending startuml with extra figure typesalbert-github2021-04-061-2/+2
| | | | | | | | | | | | | | | | | | | | 2 more supported exgines / figure types: `board` and `git` (thanks to: The-Lu, see https://forum.plantuml.net/13557/support-for-the-different-%40start-commands?show=13564#a13564)
| * | | Extending startuml with extra figure typesalbert-github2021-04-041-5/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Not all diagrams can be created with the PlantUML `@startuml` command but need another PlantUML `@start...` command. This wil look like `@start<engine>` where currently supported are the following `<engine>`'s: `uml`, `bpm`, `wire`, `dot`, `ditaa`, `salt`, `math`, `latex`, `gantt`, `mindmap`, `wbs`, `yaml`, `creole`, `json` and `flow`. By default the `<engine>` is `uml`. The `<engine>` can be specified as an option. Explicitly the option variant has been chosen so we won't get an explosion of extra commands.
* | | | Merge pull request #8501 from albert-github/feature/bug_docu_improvDimitri van Heesch2021-04-301-12/+51
|\ \ \ \ | | | | | | | | | | Some documentation improvements
| * | | | Some documentation improvementsalbert-github2021-04-131-12/+51
| | |/ / | |/| | | | | | | | | | Some small documentation improvements.
* | | | Merge pull request #8332 from albert-github/feature/issue_8329Dimitri van Heesch2021-04-291-0/+8
|\ \ \ \ | |_|_|/ |/| | | issue #8329 Force line buffering
| * | | issue #8329 Force line bufferingalbert-github2021-01-131-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | By default stdout is buffered when redirecting, the `-b` option of doxygen prevents this. Removing non used variable `outputToWizard`.
* | | | issue #8505 Local search too specificalbert-github2021-04-201-1/+5
| |/ / |/| | | | | | | | Added small explanation on searching in the documentation.
* | | remove a double "the"Olivier Couet2021-04-091-1/+1
| | |
* | | Remove a double "the"Olivier Couet2021-04-091-1/+1
| | |
* | | issue #2732: Adding support for C++ concepts (Origin: bugzilla #499352)Dimitri van Heesch2021-04-081-0/+10
| |/ |/|
* | Updated the FAQ regarding the use of QtDimitri van Heesch2021-03-291-6/+4
| |
* | Merge pull request #8460 from albert-github/feature/bug_env_changelogDimitri van Heesch2021-03-271-5/+5
|\ \ | | | | | | Environment variabelen in changelog
| * | Environment variabelen in changelogalbert-github2021-03-271-5/+5
| | | | | | | | | | | | | | | The environment variables in the changelog were replaced by their values and this was not the intention in the changelog By using the HTML Entity here for the dollar sign this can be prevented.
* | | Remove not used filealbert-github2021-03-272-3/+0
|/ / | | | | | | The file install_prefx is not used.
* | Issue #8405 Dead link in documentationalbert-github2021-03-051-2/+4
| | | | | | | | Correcting the link in the documentation to a wayback / archive machine.
* | Merge branch 'master' into feature/bug_lexDimitri van Heesch2021-03-033-3/+8
|\ \
| * | Correction end tag in documentationalbert-github2021-02-191-1/+1
| | | | | | | | | | | | Small documentation correction (missing `/` in end tag).
| * | Merge pull request #8365 from albert-github/feature/bug_ext_versionDimitri van Heesch2021-02-171-1/+2
| |\ \ | | | | | | | | Extended doxygen version information
| | * | Extended doxygen version informationalbert-github2021-01-311-1/+2
| | |/ | | | | | | | | | Create possibility for extended version information with included extra possibilities (clang / sqlite3 / ...) by means of the options `-V` / `--Version` / `--VERSION`.
| * | Merge pull request #8386 from albert-github/feature/bug_preprocessornolineno_2Dimitri van Heesch2021-02-171-0/+4
| |\ \ | | | | | | | | Get preprocessor output without line numbers
| | * | Update preprocessing.docDimitri van Heesch2021-02-161-1/+1
| | | |
| | * | Get preprocessor output without line numbersalbert-github2021-02-161-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | For easier comparison of the original source with a doxygen preprocessed source the line numbers can be a bit of an obstacle. To remove the line numbers in the preprocessor output the option `NoLineno` has been added. (In case `Preprocessor` is not invoked, `NoLineno` has no effect).
| * | | Correct documentation redirection linkalbert-github2021-02-171-1/+1
| |/ / | | | | | | | | | The link to the C#-standard has changed, it is redirected to the new place. The new place is now used in the documentation.
* | | Adding support for lex filesalbert-github2021-02-122-3/+3
|/ / | | | | | | | | | | Adding support for lex. The lex files consist of a mixture of lex specific structures, that are handled in the the lexcode.l and lexscanner.l, abd C code that is handled by the C parsers (hence the rules used are partly copied from scanner.l). Special attention has been paid to memberdef.cpp as the initial values should not be handled by the lex parsers but by the C parsers.
* | Replace the C++ doxmlparser libary by a python based moduleDimitri van Heesch2021-02-022-72/+75
|/
* Incorrect HTML sequencealbert-github2021-01-081-1/+0
| | | | Closing tag present without opening tag
* Updated changelog for release 1.9.1Dimitri van Heesch2021-01-081-0/+80
|
* bug_549093 Regular HTML comments are removed.albert-github2021-01-021-0/+1
| | | | Shall extra explanation in the documentation.
* Added changelog for 1.9.0Release_1_9_0Dimitri van Heesch2020-12-271-0/+270
|
* 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.
generated by cgit v0.12 at 2024-11-05 03:14:19 (GMT)