search

GMLC-TDC / HELICS

Hierarchical Engine for Large-scale Infrastructure Co-Simulation (HELICS)
https://docs.helics.org/en/latest/
BSD 3-Clause "New" or "Revised" License
127 stars 40 forks source link

Automated update to the C API documentation #1339

Open phlptp opened 4 years ago

phlptp commented 4 years ago

Is your feature request related to a problem? Please describe. Right now the documentation of the C api is always a bit lagging apart from the doxygen code documentation. It would be nice if the secondary lists of the documentation and function could be generated automatically and updated like the interface files are right now.

Describe the solution you'd like Automatic PR generation of some of the documentation files for the C and language API's

phlptp commented 4 years ago

I would presume #1370 if completed would resolve this issue as well. This does not presume any specific means, just that a few of the files are generated automatically.

kdheepak commented 4 years ago

That is correct.

kdheepak commented 4 years ago

I've rewritten the script to generate the documentation using LibClang.

https://gist.github.com/kdheepak/0b818874a2097bfc72ffb10f150f2308

trevorhardy commented 3 years ago

Right now the C API documentation does not show up in the helics3 branch: https://docs.helics.org/en/helics3/references/api-reference/C_API.html

I'm going to make resolving this required for v3 release. I'm going to make the link the in the documention point here under the expectation it will be resolved by release. https://docs.helics.org/en/latest/references/api-reference/C_API.html

trevorhardy commented 1 year ago

The C documentation doesn't appear to be automatically updated. For example, there is no mention of translators though there are APIs and enumerations with this string. Is this a case of a broken functionality or do we not have anything in place to auto-generate the C-API? Given how fundamental it is to most of our language bindings it would be good to have it well-maintained.

phlptp commented 1 year ago

It is not automated at present. I will update it shortly, the code to do it is in Matlab so that isn't as easy to automate, Should really translate it to python for practice in python, but haven't got around to that yet.