What is the best practice of placing example usage in code documentation? Is there a standardised way? With an @usage or @notes? Do document generators tend to support this? I know this question should depend on the documentation generator. However, I'm trying to get a habit of using a commenting style for doc generation before getting ...
I've got some C++/CLI software which is all nice and documented in a C#'ish kind of way which means DOxygen is able to pull it out into some nice html. Is there any way I can get that same information to appear in the intellisense tool tips the way that the .net framework does? For example, lets say this is my header file (MyApp.h): ...
How can I force Doxygen to show full include path? What do I mean: I have a class foo::bar::bee defined in bee.hpp in following directory structure: foo foo/bar foo/bar/bee.hpp Doxygen, when it documents foo::bar::bee class tells that you need to include <bee.hpp>, but for my software I need <foo/bar/bee.hpp> How can I cause Doxyge...
All classes of my library are defined within a namespace. When I create a mainpage for Doxygen I have to explicitly use this namespace within comments to make Doxygen generate links. I would like to use something like "using namespace" for the whole comment block. An example: /** * \mainpage My Library * * Use MyLibraryNamespace::MyCla...
We have a C# project which for historical reasons uses both Doxygen and Visual Studio style comments in the same code. Has anyone tried to systematically translate one standard to another, preferably to the common XML subset? I guess it would not be too difficult to write a script to cover the most common features, but I would not like...
Hi, Can I show the global namespace in the namespace list of the documentation generated with Doxygen? I have some functions which are extern "C", they appear in the documentation of the header file that declares them, but not in the namespace list and it gives the impression that they are not really there... ...
When I write class templates, and need to fully-specialize members of those classes, Doxygen doesn't recognize the specialization - it documents only the generic definition, or (if there are only specializations) the last definition. Here's a simple example: ===MyClass.hpp=== #ifndef MYCLASS_HPP #define MYCLASS_HPP template<class T> c...
Hello, i'm developing a quite big C++ software and now (better late than neve :)) i've decided to document it in the doxy standards. There are plenty of classes, methods, functions, macros and so on therefore i'm searching for a software that would scan my source tree and insert doxy comment blocks on top of every "documentable item" to ...
Hi guys, I'm using doxygen for commenting code. There is, for example, two files: test1.cpp: /** * @namespace SomeNamespace * @brief Describe it */ namespace SomeNamespace { ... } test2.cpp: // Put comment about namespace again? namespace SomeNamespace { ... } ...
Hi I am creating a doxygen document for my project. Recently, I have grouped related classes using \addtogroup tag. After this, I have got a module tab in my documentation. It shows all modules. I want to add some description right below module name below the module name on the same page. How can I do it using doxygen ? Here's my tag ...
Hi, I'm trying to use Doxygen with Xcode. I followed the Apple tutorial. After several mistakes, I builded the project and generated the docs. I discovered that if you save the doxygen.config from Doxygen and you use space " " in the directory name you will have problem and others things. But there is one last problem: ./search/searc...
I can't understand the virtues of using XML comments. I know they can be converted into nice documentation external to the code, but the same can be achieved with the much more concise DOxygen syntax. In my opinion the XML comments are wrong, because: They obfuscate the comments and the code in general. (They are more difficult to read...
/// \todo Loop must be rewritten ... /// \todo Delete this loop Can Doxygen generate a todo.txt file containing these comments ? ...
Using doxygen and graphviz with my C# project, I can generate class diagrams in the documentation pages. These diagrams have the full class names and namespaces in them, e.g. Acme.MyProduct.MyClasses.MyClass Is it possible to configure doxygen to cut this down a bit to just the class name? MyClass The fully qualified paths make eve...
Just about everything in my documentation ends up with the namespace:: prefix in front of it. (where namespace is the name of my namespace) Is there a way to have the documentation generated without the namespace part? For example: my_namespace::myclass::member becomes: myclass::member It would make everything more readable...
I installed Doxygen 1.6.1. I used \section, \subsection and \subsubsection for titles in C++ sources. I surprisingly obtained titles in which \subsubsection have large font size than for \subsection and \section. How can this be fixed? CSS should be used to workaround this or can I fix my doxygen installation to obtain expected common...
Usually it will ignore C files that are not documented, but I'd like to test the Callgraph feature for example, do you know a way around this without changing the C files? ...
I have been trying to document my C++ project using Doxygen, with little success: Doxygen to fails recognize certain macros, and consequently entire functions are misinterpreted and most of time does not generate docs even though they have special comment blocks. Case in point: /** * \def __MYLIB_FUNCTION_ATTRIBUTE(...) * \brief ...
Sorry for long winded title, this makes a lot more sense with an example. Suppose we have a class A: class A { public: void someFunction(); void someOtherFunction(); }; And another class that privately inherits from A. However, we re-declare one of the inherited functions as public: class B : private A { publ...
I am trying to use doxygen to generate documentation for some matlab classes I have written. I am using the doxygen-matlab package, which includes a perl script to kludge matlab .m files into c++ style commented files, so that doxygen can read them. In my doxyfile, I have set (according to the instructions) FILTER_PATTERNS = *m=...