Doxygen Activity
Brought to you by:
dimitri
Activity for Doxygen
-
anh posted a comment on discussion doxygen-users
I run doxygen with my configuration .dat file. I set: ALIASES += unique_id="\par UNIQUE ID\n". and get the the xml output contains: <simplesect kind="par"><title>UNIQUE ID</title><para>test_case1</para></simplesect> But some my team member from different country need to change the configuration file to: ALIASES += unique_id="\par UNIQUE ID^^" to get the same xml output. For my side, if I use "^^" I will not get the xml result like above. It's just: <simplesect kind="par"><title>UNIQUE ID^^ test_case1</title><para></para></simplesect>....
-
Doxygen updated /rel-1.13.2/doxygen_manual-1.13.2.pdf.zip
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
saqib abbas modified a comment on discussion doxygen-users
Hi, I would like to include a Doxyfile to my project (to generate the documentation) but I am afraid that it might affect the code license due to the GNU GPL v2 license of Doxygen. Has anybody considered this before? starbucks menu price philippinesThe example Doxyfile in the Github repository mentions also the GPL in the header. Hi, I would like to include a Doxyfile to my project (to generate the documentation) but I am afraid that it might affect the code license due to the GNU GPL v2 license...
-
Hi, I would like to include a Doxyfile to my project (to generate the documentation) but I am afraid that it might affect the code license due to the GNU GPL v2 license of Doxygen. Has anybody considered this before? https://menuland.ph/starbucks-menu-price-in-philippines/The example Doxyfile in the Github repository mentions also the GPL in the header. Hi, I would like to include a Doxyfile to my project (to generate the documentation) but I am afraid that it might affect the code license due to...
-
-
-
-
-
-
-
-
Jakob En posted a comment on discussion doxygen-users
Hi, I am having the following problem with doxygen (1.11.0) and Latex (MiKTeX-pdfTeX 4.19 (MiKTeX 24.4): I am trying to document C++ source, a minimal version to reproduce the problem is //---------------------------------------------------------------------------- /// @file doxytestnamespace.cc /// @brief minimal doxygen test file to reproduce namespace errors // /*! \namespace NAMESPACETEST \brief sample namespace test Sample namespace test */ namespace NAMESPACETEST { const double SAMPLE_VAR=48.12;...
-
-
-
-
-
-
-
-
Seppo Heikkilä posted a comment on discussion doxygen-users
Hi, I would like to include a Doxyfile to my project (to generate the documentation) but I am afraid that it might affect the code license due to the GNU GPL v2 license of Doxygen. Has anybody considered this before? The example Doxyfile in the Github repository mentions also the GPL in the header.
-
-
-
-
-
-
-
-
A V Gopinatha Reddy posted a comment on discussion doxygen-develop
Hi, We are using Doxygen v1.9.2 for one of our projects build in C programming. We are facing issues with few static functions in our project as doxygen throwing warnings by pointing to those static function declarations. The above behavour is not common for all static functions used in our project. It is limited to very few static functions. Generally we update documentation at function definitions but warning pointing to function declaration. Below is the one sample warning: warning: Member < function...
-
Andy Dent posted a comment on discussion doxygen-develop
Yes, use. GENERATE_XML then you can parse the XML to extract the info you need. The Extensions page describes several XML processing examples already built such as Doxygen.NET
-
tkratz posted a comment on discussion doxygen-develop
22.11.2023 16:24:19 Marko Filipovic mark-o@users.sourceforge.net: Hi, I'm using doxygen to generate the xml detailed documentation of the functions for projects in C and Python. I found in-body comments really usefull in C code, because with them is possible to describe code in details, and later process xml when needed. I would like to ask if this option is also available for the Python code? And if it is, how can it be achived. Whichever configuration I have tried, or comments style, comments after...
-
Marko posted a comment on discussion doxygen-develop
Hi, I'm using doxygen to generate the xml detailed documentation of the functions for projects in C and Python. I found in-body comments really usefull in C code, because with them is possible to describe code in details, and later process xml when needed. I would like to ask if this option is also available for the Python code? And if it is, how can it be achived. Whichever configuration I have tried, or comments style, comments after the first line of "in-function" code are not reported in xml...
-
Neria Adelman modified a comment on discussion doxygen-users
I've created a Collaboration Diagram by adding the argument "GENERATE_HTML = YES". Also important to note that my code contains doxygen groups. The diagram I received is attached here. The diagram describes the relations between the doxygen groups I created. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the most similar option is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow indicated...
-
I've created a Collaboration Diagram by adding the argument "GENERATE_HTML = YES". Also important to note that my code contains doxygen groups. The diagram I received is attached here. The diagram describes the relation between the doxygen groups I created. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the most similar option is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow indicated...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". Also important to note that my code contains doxygen groups. The diagram I received is attached here. The diagram describes the relation between the doxygen groups I created. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the most similar option is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". Also important to note that my code contains doxygen groups. The diagram I received is attached here. The diagram describes the relation between the doxygen groups I created. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the most similar option is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". Also important to note that my code contains doxygen groups. The diagram I recieved is attached here. The diagram describes the relation between the doxygen groups I created. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the most similar option is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". The diagram I recieved is attached here. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the closest is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow indicated a "usage" relation, the edge of the arrow is labeled with the variable(s) responsible for the relation. Class A uses class B, if class...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". The diagram I recieved is attached here. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the closest is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow indicated a "usage" relation, the edge of the arrow is labeled with the variable(s) responsible for the relation. Class A uses class B, if class...
-
I've created a Collaboration Diagram Using by adding the argument "GENERATE_HTML = YES". The diagram I recieved is attached here. It contains a purple dashed line without an arrow, this option does not exist in the doxygen documentation, the closest is a purple dashed line with an arrow, which is according to doxygen documentation: A purple dashed arrow indicated a "usage" relation, the edge of the arrow is labeled with the variable(s) responsible for the relation. Class A uses class B, if class...
-
rob posted a comment on discussion doxygen-develop
Is there some option to output Doxygen comments into some form that I can read into a C/C++/C# program? I am trying to create a code generator that uses the information generated by Oxygen comments. So I need to know the function name, argument types incl. if the argument is optional, return types, etc.
-
Thomas Seiler modified a comment on discussion doxygen-users
Hi, when creating tag files, we have some modules that do not support doxygen. Is it possible to exclude them from the tag creation? thank you
-
Hi, when creating tag files, we have some modules that do not support doxygen. Is it possible to exclude them from the tag creation? thank youalias
-
-
-
-
-
-
-
-
bits4beethoven posted a comment on discussion doxygen-users
I am wondering why doxygen truncates the source code. I want to document the following method, for example: /** * @brief Count the number of bits set to 1 in a bitmask. * @param mask Bitmask to count bits in. * @return Returns the number of bits set to 1 in the bitmask. */ static u32 count_mask_bits(u64 mask) { u32 count = 0; /* Counter for bits set to 1 */ while (mask) { /* While there are bits left in the mask */ if (mask & 1) { /* If the least significant bit is 1 */ count++; /* Increment counter...
-
oblivioncth posted a comment on discussion doxygen-users
When I started using Doxygen in 1.9.3, external namespaces from tags would show in the namespace list, which I didn't want/think was appropriate. This was resolved in 1.9.4: https://github.com/doxygen/doxygen/issues/9241 However, I just updated to 1.9.7 and it seems like 1.9.6 added them back, just now with an "[external]" mark, yet again, I don't want them there. The only loosely relevant configuration options I can see are: * ALLEXTERNALS * EXTERNAL_GROUPS * EXTERNAL_PAGES all of which I already...
-
John Davies posted a comment on discussion doxygen-users
I'm having trouble putting this into searchable terms so I'll blather a bit to real people and see what comes up. I have a very complex legacy project. It's well written but hard to wrap my brain around. Class A may contain a vector of pointers to Class B and a set of pointers to Class C. And C may contain a Map<class d,="" class="" e=""></class> You get the idea. Maybe I'm focused on Class E and I want to see the hierarchy from Class A to E. With inheritance this is easy and I've done it for years....
-
Joseph Bonanza posted a comment on discussion doxygen-users
Hello, I ran into this issue with template function specialization which seems like a bug to me, but maybe I'm just missing something. I have code that looks like this: class Checker { public: /// Fruit checking template function template <FruitType T> bool CheckFruit(int type); }; /// @brief specialized APPLE checker template<> bool Checker::CheckFruit<APPLE>(int type) { ... } /// @brief specialized ORANGE checker template<> bool Checker::CheckFruit<ORANGE>(int type) { ... } I was expecting to see...
-
Hello, Is there a way to configure pre-include files, as in the gcc preprocessor -include option? From https://gcc.gnu.org/onlinedocs/gcc/Preprocessor-Options.html#index-include: -include file Process file as if #include "file" appeared as the first line of the primary source file. However, the first directory searched for file is the preprocessor’s working directory instead of the directory containing the main source file. If not found there, it is searched for in the remainder of the #include "…"...
-
Chris Emsen posted a comment on discussion doxygen-develop
The following code incorrectly generates return type of member default_interface is not documented #include <string> static std::string default_interface ("eth1"); ///< Default Ethernet interface.
-
-
-
-
-
-
-
-
-
-
Pratyush Jayachandran posted a comment on discussion doxygen-users
I forgot to mention. The way I am documenting right now is by writing the name of the parameter or return type and then the description. Example: /** * @ingroup ntp * @brief Receives and processes the NTP packet. * @param length Length of the received NTP packet * @return void */ void NTP_Handler(int16_t length);
-
I'm trying to document a project written in C. I couldn't find the rules for documenting functions that return void and/or have no parameters. By extension of other rules, should it be @return void and @param void Omitting them will result in the document showing just blank. Is it left on the user to decide? What is the industry standard? Regards, Pratyush
-
Peter Smink posted a comment on discussion doxygen-users
Hi I'm generating both pdf as html output. When I use @startjson { "name": "json" } @endjson On the generated html, the created svg image has a proper size. However, in the generated pdf its blown up to almost the page width. Is there a way to fix this? Thanks on advance Peter
-
Maxime Gerard posted a comment on discussion doxygen-users
Hi everybody, I'm trying to document VHDL base code of my company which is segmented by subdirectories containing 1 module reusable for our projects. One module can contain a lot of VHDL files, so with a lot of modules, the documentation becomes really hard to read. I want to organize my documentation per module into a single page. Every module is independent to each other. Do you know a solution to do this? The /addgroup command is close from I want to achieve, but doesn't show the hierarchy as...
-
Pierre Clouthier modified a comment on discussion doxygen-users
Solved: in the XML files, I'm looking for kind="function" and kind="class", but Doxygen is putting out kind="slot" for Qt private slots: declarations.
-
Solved: in the XML files, I'm looking for kind="function" and kind="class", but Doxygen is putting out kind="slot" for Qt private slots: declarations.
-
"Doxygenator" automatically inserts Doxygen comment blocks before functions. Doxygenator will extract function and class information from Doxygen's XML files, create a comment block, and insert it directly into your CPP file. The Doxygen commands are a template or skeleton, you fill in the details. Great for retrofitting Doxygen to big projects. Saves you hours of drudgery. Requires: Qt. Run Doxygen on your source files Run Doxygenator, browse to your Doxygen configuration file, then select CPP files...
-
I have set EXTRACT_PRIVATE = YES, and I am seeing the private functions in the HTML files, but not in the XML. Is this a design limitation?
-
Here is a project that traverses the Doxygen XML files, and extracts a functions summary (uses Qt): https://github.com/chakani/Doxygenator
1 >
