Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate doxygen documentation [9378] #80

Merged
merged 4 commits into from
Sep 22, 2020
Merged

Generate doxygen documentation [9378] #80

merged 4 commits into from
Sep 22, 2020

Conversation

JLBuenoLopez
Copy link
Contributor

@JLBuenoLopez JLBuenoLopez commented Sep 22, 2020

Modify CMake to use BUILD_DOCUMENTATION option.
Correct several bugs in doxygen parameters
Modify README.html.in and doxyfile.in to show specific information about Fast CDR
Include several utils needed by doxigen to produce the documentation

Fast-CDR-v1_0_15.pdf: eProsima/all-docs#17

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez changed the title Generate doxygen documentation Generate doxygen documentation [9378] Sep 22, 2020
@richiware
Copy link
Member

Build status:

  • Linux Build Status
  • Windows Build Status

Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Avoid unnamed parameters and use (void) param; trick instead, so the parameters can be documented.

CMakeLists.txt Outdated Show resolved Hide resolved
Co-authored-by: Miguel Company <miguelcompany@eprosima.com>
@richiware
Copy link
Member

Build status:

  • Linux Build Status
  • Windows Build Status

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@richiware
Copy link
Member

Build status:

  • Linux Build Status
  • Windows Build Status

@MiguelCompany
Copy link
Member

Uncrustify being handled on #79

Copy link
Member

@MiguelCompany MiguelCompany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MiguelCompany MiguelCompany merged commit 76b473a into master Sep 22, 2020
@MiguelCompany MiguelCompany deleted the feature/doc branch September 22, 2020 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants