search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
306 stars 23 forks source link

extension to fortran #25

Open raphaeldussin opened 4 years ago

raphaeldussin commented 4 years ago

Hi!

I've got doxyrest working for my documentation but since it comes from fortran code it needs a little tweaking. My guess is that I should add fortran templates in frame but I'm not sure I understand how it inferfaces with the rest of the code. Pointers welcome!

thanks!

vovkos commented 4 years ago

Hi,

Apologies for the late reply. You are right, to support a new language, a new set of frames should be prepared. Modifications of the C++ portion might be required, too, but that's unlikely -- I believe that the support for Fortran could be added using frames only.

Currently, we have three sets of frames: C-family, CMake, Lua; they are located in folders frame/cfamily; frame/cmake and frame/lua respectively. CMake is the smallest and the simplest one of the three, so it probably makes sense to take it as a starting point.

The idea of frames is explained here: https://vovkos.github.io/doxyrest/manual/frames.html

The reference on the API exposed to the frames (i.e., the interface with the rest of the code you were asking for) can be found here: https://vovkos.github.io/doxyrest/manual/group_api.html

Unfortunately, I don't know enough Fortran to create a proper skeleton for the new set of frames, but I will answer any question you might have and will try to assist otherwise.