QDoc cannot change class header file shown in documentation.
-
Hi !
I am trying QDoc to check if it can be an alternative to Doxygen. I have a problem regarding the header file shown in a class documentation.
When QDoc generates the documentation for class "Something", the header file shown in the documentation will be #include<Something>. I would like to change this behaviour either by removing the information or by changing its content (e.g. #include <mydirectory/something.hpp>). I read QDoc documentation but it seems to be hardcoded in QDoc (though i hope not).
-
Hi !
I am trying QDoc to check if it can be an alternative to Doxygen. I have a problem regarding the header file shown in a class documentation.
When QDoc generates the documentation for class "Something", the header file shown in the documentation will be #include<Something>. I would like to change this behaviour either by removing the information or by changing its content (e.g. #include <mydirectory/something.hpp>). I read QDoc documentation but it seems to be hardcoded in QDoc (though i hope not).
@Tom.C-Dev said in QDoc cannot change class header file shown in documentation.:
I am trying QDoc to check if it can be an alternative to Doxygen.
Hi, be aware that QDoc's purpose is primarily for documenting Qt itself. It can be used for external libraries, but that's not its main goal so some things might not be supported.
Is there a feature that you want that's in QDoc but not in Doxygen?
-
@Tom.C-Dev said in QDoc cannot change class header file shown in documentation.:
I am trying QDoc to check if it can be an alternative to Doxygen.
Hi, be aware that QDoc's purpose is primarily for documenting Qt itself. It can be used for external libraries, but that's not its main goal so some things might not be supported.
Is there a feature that you want that's in QDoc but not in Doxygen?
@JKSH said in QDoc cannot change class header file shown in documentation.:
Is there a feature that you want that's in QDoc but not in Doxygen?
I am not after a specific feature. QDoc just picked my interest.
@JKSH said in QDoc cannot change class header file shown in documentation.:
Be aware that QDoc's purpose is primarily for documenting Qt itself.
From what i understand, QDoc has all the features required to generate documentation for any C++ API (since Qt is mainly a C++ framework with some extensions).
-
Hi,
That's a pretty good question. I wold recommend bringing it to the interest mailing list. You'll find there
qdocdevelopers/maintainers. This forum is more user oriented.
