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

Doxygen system added to DGtaltools #258

Merged
merged 47 commits into from
May 21, 2016
Merged

Conversation

dcoeurjo
Copy link
Member

@dcoeurjo dcoeurjo commented May 8, 2016

PR Description

This PR adds doxygen scripts to DGtalTools. More precisely, doxygen and cmake scripts define a new make doc target to generate the tool documentation.

Few comments:

  • the main page is in doc/mainpage.dox
  • only vol2obj tool doc has been added. For this tool, the doc is rather simple (just a copy of the --help).

TODO

  • create a specific CSS/HTML template to distinguish DGtal from DGtalTools doc
  • use travis to generate the doc as for DGtal
  • make sure that DGtal doc can refer to tools (with proper link)
  • add more info to the main page
  • Details Converters section tools
  • Details Estimators section tools
  • Details ShapeGenerator section tools
  • Details Visualization section tools
  • Details Volumetric section tools

Checklist

  • Doxygen documentation of the code completed (classes, methods, types, members...)
  • Check if it follows the tools structure described in CONTRIBUTING.md
  • New entry in the ChangeLog.md added.
  • Update the readme with potentially a screenshot of the tools if it applies.
  • No warning raised in Debug cmake mode (otherwise, Travis C.I. will fail).

@dcoeurjo
Copy link
Member Author

dcoeurjo commented May 8, 2016

ping @JacquesOlivierLachaud & @kerautret

@kerautret
Copy link
Member

Yes thanks I look it this afternoon

Le 8 mai 2016 à 11:03, David Coeurjolly notifications@github.com a écrit :

ping @JacquesOlivierLachaud & @kerautret


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub

@kerautret
Copy link
Member

@dcoeurjo done for the custom style doc (in PR in your branch), I continue with the add of info

@kerautret
Copy link
Member

@dcoeurjo done for Converters sections tools (see PR on your branch)
Starting doing smaller one ShapeGenerator ;)

@kerautret
Copy link
Member

@dcoeurjo done for ShapeGenerator sections tools (see PR on your branch)
Starting doing Visualization ;)

@kerautret
Copy link
Member

kerautret commented May 12, 2016

@dcoeurjo done for Visualization sections tools (see PR on your branch)
Starting doing Volumetric ;)

@kerautret
Copy link
Member

@dcoeurjo done for Volumetric sections tools (see PR on your branch)
Starting doing the last one with Estimators ;)

@dcoeurjo
Copy link
Member Author

Excellent. I ll prepare the script so that Travis can push the doc. Thanks a lot

@dcoeurjo
Copy link
Member Author

can you reopen the PR to my branch ?

@kerautret
Copy link
Member

done, but it was not closed so I close and re open ;)

@kerautret
Copy link
Member

@dcoeurjo done for the last one (Estimators)!
By the way I have corrected minor issue for some tools and add some options for some one in order to have good visual examples.

@dcoeurjo
Copy link
Member Author

@kerautret I'll merge this branch in order to debug the deployment of the documentation when a PR is merged.

@dcoeurjo dcoeurjo merged commit 1ead2c3 into DGtal-team:master May 21, 2016
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.

None yet

2 participants