Documentation translation - Doxygen?

Question

Documentation translation - Doxygen?

Opened this issue 11 years ago · 12 comments

Since all comments will be touched anyway, would it be sensible to rewrite them as Doxygen-comments? It will make it a lot easier to hold code and documentation in sync. It can generate both HTML and linux manpages (and more), and can be run on both Linux and Windows.

Quick and dirty test:
http://offle.hild1.no/~hildenae/files/static/fyba-doxygen/html/_f_y_l_o_8cpp.html#a13144af5f7f1d5d51faae47e0a4748d7
http://offle.hild1.no/~hildenae/files/static/fyba-doxygen/refman.pdf

Answer 1 · 2013-10-24T07:35:14.000Z

I think the documentation is auto-generated already - @rosand can tell us what they use to generate their documentation when he's back.

Answer 2 · 2013-10-24T08:49:24.000Z

When is he back? :) I've noticed the code uses special comments, but have been unable to find out what tool it is based of. It does not look really parseable/interlinkable.

Answer 3 · 2013-10-29T20:02:31.000Z

Any updates?

Answer 4 · 2013-10-30T10:51:30.000Z

I am back.
The documentation is made in a old proprietary documentation program fyDok. We are now comverting to Doxygen for all new sourcecode, and the documentation for FYBA should also be rewriten.

Answer 5 · 2013-10-30T10:55:28.000Z

Do you have any standards for how you do it? What tags, doxygen settings,
etc? Would be nice if you could share it, so we could follow the same when
translating.

Answer 6 · 2013-10-30T12:24:43.000Z

We have a document describing our use of Doxygen. We are new users of Doxygen, so please suggest improvements in the use of Doxygen.

How do I distribute this file?

Answer 7 · 2013-10-30T12:43:09.000Z

What kind if document are we discussing? Pdf? Doc? Html? Txt? Wiki? Postit
notes? :)

Repositories on Github have wiki pages, I guess that could be a good place.

My experience with Doxygen is limited, but I might be able to come up with
some suggestions.

Answer 8 · 2013-10-30T12:49:58.000Z

The document is Docx/Pdf.

Answer 9 · 2013-10-30T12:58:23.000Z

Then I have no "good" suggestions, but maybe Google docs, or if it is
trivial, copypaste it to the wikipages.

Answer 10 · 2013-11-04T11:50:21.000Z

If you don't feel like distributin it, or want someone to copypaste/format it for you, feel free to send it to me. You can find my email on my profile page.

Answer 11 · 2013-11-05T21:26:41.000Z

Is/will norwegian be the "internal" documentation language at Kartverket? If so, would it be a good idea to maintain bilingual documentation for the Fyba code? I have an examle in the mainpage translation that i have started on here: https://github.com/Kagee/fyba/blob/translate-code/src/FYBA/mainpage.dox

This will allow you to generate two sets of documentation by editing the Doxyfile or passing arguments (as makedocs.sh does)

Answer 12 · 2013-11-08T09:31:21.000Z

Our "internal" documentation language will be Norwegian for the complete set of software we make. It is no problem to change to English as the documentation language for fyba. There is no reason for maintaining two sets of documentation.