Skip to content

Resolve issue #38 (doxygen documentation) #61

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.

Sign up for GitHub

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

Jump to bottom
Merged
11 commits merged into from
Apr 3, 2017
Merged

Resolve issue #38 (doxygen documentation) #61

11 commits merged into from
Apr 3, 2017

Conversation

@AhmedMzid
Copy link
Contributor

@AhmedMzid AhmedMzid commented Mar 31, 2017

  • The added file doxygen_config.cmake.in will be configured from cmake to generate a file named Doxyfile in the cmake binary directory.
  • Doxyfile is the configuration file used by doxygen to generate the required documentation using a filter proto2cpp.py (required to make the proto files compatible with doxygen).
  • Diagrams are created by the visualization tool Graphviz.
    For further details see README.md

@AhmedMzid AhmedMzid requested a review from a user March 31, 2017 11:16
@ghost ghost added this to the Pegasus Workshop Changes milestone Mar 31, 2017
@AhmedMzid
Update README.md
0d320ad 
Change the filter version
PhilippRoethigBMW
PhilippRoethigBMW reviewed Apr 3, 2017
View reviewed changes
README.md Outdated
-------------

In order to generate the doxygen documentation for OSI, please follow the following steps:
1. Install [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), set an environmental variable 'doxygen' with the path to the binary file and add it to PATH `<old-path>;%doxygen%`.
Copy link
Contributor

@PhilippRoethigBMW PhilippRoethigBMW Apr 3, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Meaning of old-path might confuse.
My proposel: PATH += %doxygen%

Copy link

@ghost ghost Apr 3, 2017

Choose a reason for hiding this comment

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

agree and done

PhilippRoethigBMW
PhilippRoethigBMW reviewed Apr 3, 2017
View reviewed changes
Copy link
Contributor

@PhilippRoethigBMW PhilippRoethigBMW left a comment •
edited
Loading

Choose a reason for hiding this comment

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

What do you think about an update of the wiki covering the "how to write comments correctly for doxygen"?

jdsika added 2 commits April 3, 2017 15:38
@jdsika
Update README.md
afd7978 
Changed the download location to the correct VG release containing the doxygen filter python script and changed the documentation
@jdsika
Update README.md
a177659 
corrected readme.md
@ghost ghost added Documentation Everything which impacts the quality of the documentation and guidelines. FeatureRequest Proposals which enhance the interface or add additional features. labels Apr 3, 2017
@jdsika
Update README.md
ff396db 
Changed the readme.md according to suggestion
@ghost ghost merged commit d32e6d8 into master Apr 3, 2017
@ghost
Copy link

ghost commented Apr 4, 2017

fix #38

@pmai pmai deleted the feature/add-doxygen-doc branch January 18, 2018 12:12
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@PhilippRoethigBMW PhilippRoethigBMW PhilippRoethigBMW left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation Everything which impacts the quality of the documentation and guidelines. FeatureRequest Proposals which enhance the interface or add additional features.

Projects

None yet

Milestone

Pegasus Workshop Changes

Development

Successfully merging this pull request may close these issues.

4 participants

@AhmedMzid @PhilippRoethigBMW @jdsika