Adjustment of Doxygen documentation (enable) #536
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pjanck
requested changes
Apr 8, 2022
christophKaiser
added
bug
This reverts commit 13658ae.
|
Commit aae0c68 is only an optional suggestion from my side. At the end of the setup process, probably not everyone takes a detailed look into the Doyxgen guidelines. |
christophKaiser
changed the title
pjanck
requested changes
Apr 11, 2022
| @@ -19,23 +19,27 @@ Refer to the [doxygen manual](http://www.doxygen.nl/manual) for everything else. | |||
|
|
|||
| ## Doxygen settings in CMake | |||
|
|
|||
| By default, doxygen is disabled. | |||
| To enable doxygen, search for the `DOXYGEN_GENERATE_DOCUMENTATION` option in CMake and set the check box. | |||
There was a problem hiding this comment.
Since we're revisiting this in this PR, I'd propose to prepend the variable with OIP_ so that it is grouped together with other OIP's variables. Please change accordingly everywhere, where it comes up (I assume there are mentions in the Doxygen documentation as well).
Comment on lines
30
to
+34
| Additionally, the following options can be selected: | ||
| - `DOXYGEN_INCLUDE_COMMENTED_ONLY` (default = ON): If selected, only the documentation for explicitly commented entities will be generated. Otherwise, doxygen will assume that all entities are documented, even if there is no documentation available. | ||
| - `DOXYGEN_INCLUDE_INTERNAL` (default = OFF): If selected, this will include all comments preceded by "\internal". These are comments intended for developers only. So if the generated documentation is intended for external users, this option should not be selected. | ||
| - DOXYGEN_INCLUDE_EARLYBINDING (default = OFF): If selected (... and already built), this will include the selected IFC schemas in the documentation. Otherwise, the schemas will not be included in the documentation, but this does not influence the selection of IFC schemas (see EARLYBINDING_ tags in CMake GUI). | ||
| - DOXYGEN_AUTO_OPEN_DOCUMENTATION (default = ON): If selected, the landing page of the documentation will automatically open. If not selected, you will have to find and open the generated documentation manually (see section below on building the documentation). | ||
| - `DOXYGEN_INCLUDE_EARLYBINDING` (default = OFF): If selected (... and already built), this will include the selected IFC schemas in the documentation. Otherwise, the schemas will not be included in the documentation, but this does not influence the selection of IFC schemas (see EARLYBINDING_ tags in CMake GUI). | ||
| - `DOXYGEN_AUTO_OPEN_DOCUMENTATION` (default = ON): If selected, the landing page of the documentation will automatically open. If not selected, you will have to find and open the generated documentation manually (see section below on building the documentation). |
There was a problem hiding this comment.
Apply here as well (prepend with OIP_).
| @@ -177,6 +177,7 @@ Build the project **OpenInfraPlatform.GenerateDocumentation** within *Commands* | |||
| *NOTE:* This step may take quite some time. | |||
|
|
|||
| Read more about Doxygen in our [guidelines](./DoxygenHelp.md). | |||
| *NOTE:* Doxygen is disabled by default. See the guidelines for a description how to enable Doxygen. | |||
There was a problem hiding this comment.
Suggested change
| *NOTE:* Doxygen is disabled by default. See the guidelines for a description how to enable Doxygen. | |
| *NOTE:* Documentation generation is disabled by default. See the guidelines for a description of how to enable Doxygen. |
|
Since we're renaming already, I'd call these variables |
jschlenger
reviewed
Apr 12, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #535, detailed description with test of the suggested change in the issue.