I'm trying to find a solution for generating documents for me open source project. I have 2 choices, either http://www.sphinx-doc.org/en/stable/ or QDoc. I lean to use QDoc, as I'm new to sphinx and my project is written in Qt. But last time I tried QDoc (3 years ago), It could only generate document for public member functions of a class. It means to create a public document for external users. However, I want to create a document for internal developers, with implementation details of function internals, including private functions. I found a thread requesting this 5 years ago. What's the current state?

Hi, Can you share the thread where you find that ? If you want such a status report, you should rather check the interest mailing list . You'll find there Qt's developers/maintainers. This forum is more user oriented.

Your browser does not seem to support JavaScript. As a result, your viewing experience will be diminished, and you have been placed in read-only mode.

Please download a browser that supports JavaScript, or enable it if it's disabled (i.e. NoScript).

QtWS: Super Early Bird Tickets Available!

Can QDoc generate document for private members?

Unsolved Qt Creator and other tools

2 Posts 2 Posters 886 Views

B Offline

B Offline
billconan
wrote on last edited by

#1

I'm trying to find a solution for generating documents for me open source project.

I have 2 choices,

either http://www.sphinx-doc.org/en/stable/ or QDoc.

I lean to use QDoc, as I'm new to sphinx and my project is written in Qt.

But last time I tried QDoc (3 years ago), It could only generate document for public member functions of a class. It means to create a public document for external users.

However, I want to create a document for internal developers, with implementation details of function internals, including private functions.

I found a thread requesting this 5 years ago. What's the current state?
1 Reply Last reply
0
S Offline

S Offline
SGaist Lifetime Qt Champion
wrote on last edited by

#2

Hi,

Can you share the thread where you find that ?

If you want such a status report, you should rather check the interest mailing list. You'll find there Qt's developers/maintainers. This forum is more user oriented.
Interested in AI ? www.idiap.ch
Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

1 Reply Last reply
0