Building and publishing API docs

[ulysses4ever]

I noticed many function-level comments start with /*!, which suggests that they're written with qdoc in mind. Unless I'm missing it, there's no publicly available instance of the generated API docs. It'd make sense to generate and host them under https://owl-project.github.io/ perhaps?

[ingowald]

Sorry for the late reply; i'm sure i had replied to that already but seems it didn't go through. SO here it is again: For some other projects in the past I've used DoxyGen; and in that process got used to writing comments in that style - getting a project "really" usefully documented with these tools is a bit more work than just the function (and maybe \file) comments, but at least it's a start. I haven't really started on working on that "more complete doxygen-style documentations"-task for owl, yet, but yes, that's where it's eventually supposed to go (BTW I don't know 'qdoc', but assume it's something similar). If you do want to get involved in that, please let me know - we can definitely put that to a subdir of the above url, that would make totals sense.

[ulysses4ever]

No worries, and thanks for taking the time to answer it (twice!). I'll try to take a closer look at it this or next week.

The reason I mentioned qdoc is purely accidental and due to the /*! style of comments, which I didn't know are supported by Doxygen. Particular syntax doesn't matter too much hopefully.

[ulysses4ever]

I created a close-to-default Doxyfile, and added auto-deployment via GitHub Pages on my fork:

• https://ulysses4ever.github.io/owl/

The patch:

• https://github.com/ulysses4ever/owl/commit/3ca640145791bfa032aebf768894d4169ef20ffe

If you have any feedback, I'd be happy to take it.

[ulysses4ever]

Just a gentle ping here, @ingowald: do you have any thoughts on deploying Doxygen for OWL as shown above?