API docs for my CPP properties
-
Hello,
in a mixed CPP / QML project we have a dozen cpp objects with each of them plenty of properties.
I personally already have issues that I have to jump to the cpp-header file to read the list of properties there as there is a context switch I don't like. But I'd love to get people that are not familiar with the cpp part to work on the QML files, and there this link doesn't make much sense at all.
So, I'm wondering how others solve that. Is there a good way to auto-generate some documentation (can be as simple as markdown) pages from my cpp files? Something we can put online.
Again, this is specifically for the QML user, so only stuff that actually is possible to use from the QML side should be included.
Thanks!
-
Hello,
in a mixed CPP / QML project we have a dozen cpp objects with each of them plenty of properties.
I personally already have issues that I have to jump to the cpp-header file to read the list of properties there as there is a context switch I don't like. But I'd love to get people that are not familiar with the cpp part to work on the QML files, and there this link doesn't make much sense at all.
So, I'm wondering how others solve that. Is there a good way to auto-generate some documentation (can be as simple as markdown) pages from my cpp files? Something we can put online.
Again, this is specifically for the QML user, so only stuff that actually is possible to use from the QML side should be included.
Thanks!
-
@TomZ said in API docs for my CPP properties:
Again, this is specifically for the QML user, so only stuff that actually is possible to use from the QML side should be included.
@sierdzio Is there any specific reason you think that it can ignore the C++ API from classes and list only the QML relevant parts?
The configuration or manual of doxygen doesn't give any indication it is capable of doing so.
-
@TomZ said in API docs for my CPP properties:
Again, this is specifically for the QML user, so only stuff that actually is possible to use from the QML side should be included.
@sierdzio Is there any specific reason you think that it can ignore the C++ API from classes and list only the QML relevant parts?
The configuration or manual of doxygen doesn't give any indication it is capable of doing so.
Documentation will only contain what you tell it to contain. If you don't document the C++ internals, they will not end up in the docs.
