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 manual examples missing #738

Closed
gdolle opened this issue Mar 30, 2016 · 4 comments
Closed

Doxygen manual examples missing #738

gdolle opened this issue Mar 30, 2016 · 4 comments

Comments

@gdolle
Copy link
Contributor

gdolle commented Mar 30, 2016

The documentation section for the manual examples seems missing in the API.
The *.doc files in "feelpp/doc/manual/" for most example are not displayed at http://doc.feelpp.org/
It seems there is a problem with doxygen configuration.

@vhuber
Copy link
Contributor

vhuber commented Mar 30, 2016

doc.feelpp.org is intended for the library developers: the manual documentation has to be moved to the feelpp-book.

@vhuber vhuber closed this as completed Mar 30, 2016
@prudhomm
Copy link
Member

yes but @gdolle is right, some documentation disappeared, namely the one from example files with doxygen keywords in them.
we should recobver them or rewrite them

@gdolle gdolle reopened this Mar 30, 2016
@gdolle
Copy link
Contributor Author

gdolle commented Mar 30, 2016

As mentionned @prudhomm, there was an "example" section in doxygen that is not in the feelpp-book and was generated thanks to code comments parsing. Also it parse specific *.doc files. For example I see there's still doc/manual/heat/heatsink.doc.

Currently there is no more documentation available for feel++ examples online (either in the API nor in the feelpp-book) and I think that is a serious problem.

If everyone agree to put these docs in the feel++ book, I'd be glad to rename the issue.

@github-actions
Copy link

Stale issue message

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants