doxygen-users Mailing List for Doxygen (Page 4)
Brought to you by:
dimitri
You can subscribe to this list here.
2001 |
Jan
|
Feb
|
Mar
|
Apr
(1) |
May
(118) |
Jun
(150) |
Jul
(115) |
Aug
(75) |
Sep
(92) |
Oct
(102) |
Nov
(139) |
Dec
(87) |
---|---|---|---|---|---|---|---|---|---|---|---|---|
2002 |
Jan
(131) |
Feb
(60) |
Mar
(114) |
Apr
(83) |
May
(125) |
Jun
(82) |
Jul
(95) |
Aug
(98) |
Sep
(109) |
Oct
(97) |
Nov
(72) |
Dec
(70) |
2003 |
Jan
(117) |
Feb
(122) |
Mar
(187) |
Apr
(114) |
May
(154) |
Jun
(131) |
Jul
(130) |
Aug
(98) |
Sep
(121) |
Oct
(107) |
Nov
(80) |
Dec
(54) |
2004 |
Jan
(78) |
Feb
(71) |
Mar
(118) |
Apr
(56) |
May
(56) |
Jun
(64) |
Jul
(164) |
Aug
(104) |
Sep
(101) |
Oct
(69) |
Nov
(107) |
Dec
(98) |
2005 |
Jan
(75) |
Feb
(77) |
Mar
(107) |
Apr
(114) |
May
(142) |
Jun
(106) |
Jul
(79) |
Aug
(108) |
Sep
(115) |
Oct
(140) |
Nov
(128) |
Dec
(63) |
2006 |
Jan
(86) |
Feb
(71) |
Mar
(125) |
Apr
(55) |
May
(48) |
Jun
(143) |
Jul
(99) |
Aug
(91) |
Sep
(93) |
Oct
(82) |
Nov
(46) |
Dec
(45) |
2007 |
Jan
(69) |
Feb
(97) |
Mar
(125) |
Apr
(112) |
May
(65) |
Jun
(80) |
Jul
(82) |
Aug
(84) |
Sep
(56) |
Oct
(74) |
Nov
(63) |
Dec
(74) |
2008 |
Jan
(161) |
Feb
(115) |
Mar
(58) |
Apr
(73) |
May
(58) |
Jun
(79) |
Jul
(57) |
Aug
(115) |
Sep
(79) |
Oct
(62) |
Nov
(93) |
Dec
(37) |
2009 |
Jan
(69) |
Feb
(115) |
Mar
(77) |
Apr
(85) |
May
(124) |
Jun
(58) |
Jul
(44) |
Aug
(85) |
Sep
(90) |
Oct
(80) |
Nov
(87) |
Dec
(48) |
2010 |
Jan
(52) |
Feb
(71) |
Mar
(54) |
Apr
(37) |
May
(66) |
Jun
(86) |
Jul
(84) |
Aug
(68) |
Sep
(94) |
Oct
(66) |
Nov
(36) |
Dec
(53) |
2011 |
Jan
(59) |
Feb
(77) |
Mar
(59) |
Apr
(67) |
May
(76) |
Jun
(54) |
Jul
(95) |
Aug
(92) |
Sep
(84) |
Oct
(72) |
Nov
(46) |
Dec
(60) |
2012 |
Jan
(43) |
Feb
(77) |
Mar
(88) |
Apr
(121) |
May
(81) |
Jun
(69) |
Jul
(97) |
Aug
(64) |
Sep
(55) |
Oct
(55) |
Nov
(38) |
Dec
(60) |
2013 |
Jan
(85) |
Feb
(70) |
Mar
(81) |
Apr
(83) |
May
(51) |
Jun
(65) |
Jul
(71) |
Aug
(39) |
Sep
(47) |
Oct
(32) |
Nov
(43) |
Dec
(28) |
2014 |
Jan
(64) |
Feb
(22) |
Mar
(54) |
Apr
(20) |
May
(59) |
Jun
(20) |
Jul
(50) |
Aug
(17) |
Sep
(37) |
Oct
(56) |
Nov
(40) |
Dec
(24) |
2015 |
Jan
(51) |
Feb
(29) |
Mar
(57) |
Apr
(31) |
May
(23) |
Jun
(50) |
Jul
(30) |
Aug
(66) |
Sep
(59) |
Oct
(21) |
Nov
(29) |
Dec
(12) |
2016 |
Jan
(33) |
Feb
(30) |
Mar
(19) |
Apr
(23) |
May
(16) |
Jun
(31) |
Jul
(17) |
Aug
(19) |
Sep
(21) |
Oct
(20) |
Nov
(15) |
Dec
(6) |
2017 |
Jan
(16) |
Feb
(13) |
Mar
(16) |
Apr
(23) |
May
(16) |
Jun
(5) |
Jul
(14) |
Aug
(13) |
Sep
(12) |
Oct
(11) |
Nov
(3) |
Dec
(6) |
2018 |
Jan
(4) |
Feb
(6) |
Mar
(5) |
Apr
(11) |
May
(26) |
Jun
(5) |
Jul
(10) |
Aug
(7) |
Sep
(3) |
Oct
|
Nov
(3) |
Dec
(7) |
2019 |
Jan
(17) |
Feb
(18) |
Mar
(5) |
Apr
(6) |
May
(3) |
Jun
|
Jul
(9) |
Aug
(19) |
Sep
(3) |
Oct
(1) |
Nov
(23) |
Dec
(5) |
2020 |
Jan
(7) |
Feb
(1) |
Mar
(7) |
Apr
(11) |
May
(8) |
Jun
(7) |
Jul
(10) |
Aug
(3) |
Sep
(4) |
Oct
(7) |
Nov
(6) |
Dec
|
2021 |
Jan
(3) |
Feb
|
Mar
(4) |
Apr
(4) |
May
|
Jun
|
Jul
(1) |
Aug
(3) |
Sep
|
Oct
|
Nov
(8) |
Dec
(3) |
2022 |
Jan
(2) |
Feb
|
Mar
(1) |
Apr
|
May
(3) |
Jun
(1) |
Jul
|
Aug
(3) |
Sep
(9) |
Oct
(2) |
Nov
|
Dec
(2) |
2023 |
Jan
(2) |
Feb
(5) |
Mar
(3) |
Apr
(7) |
May
(6) |
Jun
(2) |
Jul
(5) |
Aug
|
Sep
(4) |
Oct
(1) |
Nov
(5) |
Dec
(5) |
2024 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(3) |
Jun
(4) |
Jul
|
Aug
(3) |
Sep
|
Oct
|
Nov
(1) |
Dec
|
From: Davina R. <Dav...@ma...> - 2022-05-02 14:27:25
|
Hi all, I'm trying to figure out a way to reuse snippets of non-code text in multiple dox files. I've tried a few things from creating .md files to .cpp files to .dox files and added plain text there which I then try to reference in another .dox file but I cannot get it to work. I got it to work from a .cpp file but the text that appeared was formatted by default as code rather than plain text. Is this possible in Doxygen? For example, supported systems information is common to many products, and I want to have one file with the supported systems text snippet in it, which I then reference in all dox files that need that info. I can then update that text snippet only once in a file where I have all snippets defined and that snippet is then automatically updated for all locations where it is referenced in at time of compiling. FYI, I'm a technical writer and not a programmer but I can read some code and fiddle around with code a little. Thanks for any pointers. The preceding e-mail message (including any attachments) contains information that may be confidential, may be protected by the attorney-client or other applicable privileges, or may constitute non-public information. It is intended to be conveyed only to the designated recipient(s) named above. If you are not an intended recipient of this message, please notify the sender by replying to this message and then delete all copies of it from your computer system. Any use, dissemination, distribution, or reproduction of this message by unintended recipients is not authorized and may be unlawful. |
From: <c....@po...> - 2022-03-07 15:57:10
|
Hello, even after reading the documentation and looking in some examples it is unclear for me what PYTHON_DOCSTRING does. Is it a cosmetic thing or is there more behind it? Kind Christian |
From: Will P. <wi...@yo...> - 2022-01-19 11:59:15
|
I define a property in an ObjC class using DEPRECATED_MSG_ATTRIBUTE to output a warning when building against the API: ** Defines the type of the object * @return The object type as a string * @deprecated Will be removed in v3.4.0 */ @property (nullable, readonly) NSString *type DEPRECATED_MSG_ATTRIBUTE("Use property: instead"); Doxygen 1.9.2 parses this block and creates html (including the deprecated comment), but thinks this is a method rather than a property: <>Instance Methods (NSString *type) - DEPRECATED_MSG_ATTRIBUTE <file:///Users/will/Documents/development/SDK/apple/admanagement/YOAdManagement/dist/Documentation/html/interface_y_o_ad_break.html#ae461161d33e97686512fade8dccd7135> ... ◆ <file:///Users/will/Documents/development/SDK/apple/admanagement/YOAdManagement/dist/Documentation/html/interface_y_o_ad_break.html#ae461161d33e97686512fade8dccd7135>DEPRECATED_MSG_ATTRIBUTE - (NSString *type) DEPRECATED_MSG_ATTRIBUTE (“Use property: instead") Defines the type of the object Returns The object type as a string Deprecated: <file:///Users/will/Documents/development/SDK/apple/admanagement/YOAdManagement/dist/Documentation/html/deprecated.html#_deprecated000001> Will be removed in v3.4.0 Is there something I am missing? I see that it has been used successfully in another project: https://app.mapsindoors.com/mapsindoors/reference/ios/v3/_m_p_location_8h_source.html <https://app.mapsindoors.com/mapsindoors/reference/ios/v3/_m_p_location_8h_source.html> output https://app.mapsindoors.com/mapsindoors/reference/ios/v3/interface_m_p_location.html#a740623ead5e934170dea0765804c410f <https://app.mapsindoors.com/mapsindoors/reference/ios/v3/interface_m_p_location.html#a740623ead5e934170dea0765804c410f> but I’m not sure how (unless the author temporarily removed the macro in the header before parsing with Doxygen. Any help gratefully accepted! |
From: Adrian Ho <ml+...@03...> - 2022-01-05 05:20:27
|
Hi! I help out with the Homebrew project (https://brew.sh) on occasion, and it's come to our attention that the doxygen-1.9.3.tar.gz release tarball on your website was changed sometime after its initial release. As our doxygen formula tracks SHA256 checksums of source tarballs, we were alerted to this after one of our users tried to build from source and got a checksum error: https://github.com/Homebrew/discussions/discussions/2726 I downloaded the current tarball to verify it myself, and noticed a number of files in the src directory dated after the Dec 31 initial release. Since there's no accompanying note about the changes, may I ask what they were? That would help determine whether we have to rebuild and release new precompiled bottles for all our users. Thanks much! Best Regards, Adrian |
From: Paul J. L. <pa...@lu...> - 2021-12-19 15:57:44
|
Hello - For my C code documentation, I like links to code (function names, struct names, etc.) to look like code, i.e., be in a fixed-width font. I originally put such links inside either `` (backticks) or <code></code> manually, but that’s tedious. Since Doxygen allows tweaking of CSS via HTML_EXTRA_STYLESHEET, I thought I’d try that. By inspecting the generated HTML, I discovered that Doxygen uses the “el” HTML class for links, e.g.: <a class="el" href="structc__ast__pair.html">c_ast_pair_t</a> The default CSS for “el” is: a.el { font-weight: bold; } so I just made it: a.el { font-family: monospace, fixed; font-weight: bold; } instead. This works for the most part, but there are a couple of problems: 1. Doxygen also uses “el” for links to things that aren’t code which means things that aren’t code end up using a fixed-width font — which isn’t what I want. 2. If I use \ref with an alternate title like: \ref c_ast_pair_t “AST pair” then the text “AST pair” is fixed-width when it shouldn’t be. So, ideally Doxygen should: 1. Use a specific CSS “code class" for things that are code and nothing else. 2. When using \ref to something that is code with an alternate title, do NOT use the “code class”, i.e., providing an alternate title should suppress using the “code class” and the generated HTML <a href> link will be class-less so the text for the link just blends into the surrounding text. Or: is there another way to get what I want (all code and links to code, but nothing else, to be fixed-width)? - Paul |
From: Carsten S. <ca...@fa...> - 2021-12-16 07:05:55
|
Hi Matthias, as doxygen is developed in C++ I do not expect any vulnerabilities resulting fron that CVE. Best regards, Carsten Schumann Am 16. Dezember 2021 07:13:59 MEZ schrieb "Baumann, Matthias" <mat...@th...>: > > > >thyssenkrupp Marine Systems GmbH >Aufsichtsratsvorsitzender/Supervisory Board (Chairman): Oliver Burkhard >Gesch?ftsf?hrung/Executive Board: Dr. Rolf Wirtz (Chairman), Paul >Glaser, Bernd Hartmann, Dr. Luis Alejandro Orellano >Sitz der Gesellschaft/Registered Office: Kiel, >Registergericht/Commercial Register: Kiel HRB 6960 KI >This e-mail (including any attachments) may contain confidential and/or >privileged information. Any unauthorized >use or dissemination of this message in whole or in part is strictly >prohibited. If you are not the intended recipient >(or have received this e-mail in error) please notify the sender >immediately and destroy this e-mail. -- Diese Nachricht wurde von meinem Android-Gerät mit K-9 Mail gesendet. |
From: Baumann, M. <mat...@th...> - 2021-12-16 06:30:17
|
thyssenkrupp Marine Systems GmbH Aufsichtsratsvorsitzender/Supervisory Board (Chairman): Oliver Burkhard Gesch?ftsf?hrung/Executive Board: Dr. Rolf Wirtz (Chairman), Paul Glaser, Bernd Hartmann, Dr. Luis Alejandro Orellano Sitz der Gesellschaft/Registered Office: Kiel, Registergericht/Commercial Register: Kiel HRB 6960 KI This e-mail (including any attachments) may contain confidential and/or privileged information. Any unauthorized use or dissemination of this message in whole or in part is strictly prohibited. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. |
From: Sean P. <sea...@gm...> - 2021-11-23 12:38:39
|
Hi, I'm using doxygen in github-actions to render .stan files. I'm mapping the .stan extension to c++, so I'm afraid that this is due to the c++ parser. I've attached a screenshot of the issue (hopefully it renders). I'll try to describe it below. In the "Function Documentation" tab under the function name there is the signature of the function. Stan allows the declaration of 'array[ ] real` but it is render without the space after ']' and between 'real' as `array[ ]real`. Does anyone know how to fix this? [image: Screen Shot 2021-11-23 at 7.34.05 AM.png] |
From: <mi...@fo...> - 2021-11-23 12:37:14
|
Hi, I'm Mira. I was trying to generate documentation with CMake and Doxygen recently. I'm a little confused about how to input markdown file through cmake. As in 'Doxyfile',I just use 'INPUT' and 'FILE_PATTERNS' like: ``` INPUT = docs/pages \ src FILE_PATTERNS = *.cpp \ *.h \ *.md ``` where pages is the directory of the markdown files. In this way, I can get what I want. But,when I try to use cmake like: ``` file(GLOB_RECURSE DOCS_FILE ${CMAKE_CURRENT_LIST_DIR}/src/*.h ${CMAKE_CURRENT_LIST_DIR}/src/*.cpp ${CMAKE_CURRENT_LIST_DIR}/docs/pages/*.md ) doxygen_add_docs(doc ${DOCS_FILE} ALL USE_STAMP_FILE COMMENT "Generate documentation with cmake") ``` As pages, everything is fine. But there's a 'Files' module in the html document, and the pages will be considered as files like: which are not considered as files when I just use Doxyfile. What bothers me the most is when i open the pages in this file list ,it will be empty cuz there's no comments of "file" thing in such markdown files. And if I remove pages in GLOB_RECURSE ,my pages won't be normally displayed. So my question is how to get rid of showing the markdown pages in "files" while using cmake? THANKS SO MUCH! Mira |
From: Grant E. <gra...@gm...> - 2021-11-18 16:21:53
|
On 2021-11-18, Finch, Alex <A....@la...> wrote: > If it is specifically searching you are interested in have you looked > into server side searching? There is no server. [I assume you're referrint to an HTTP server?] > I use a modified form of the official one to get what I want on my > site. Specifically I modified the code in addon/doxysearch/ > doxyindexer.cpp and doxysearch.cpp -- Grant |
From: Finch, A. <A....@la...> - 2021-11-18 08:42:45
|
If it is specifically searching you are interested in have you looked into server side searching? I use a modified form of the official one to get what I want on my site. Specifically I modified the code in addon/doxysearch/ doxyindexer.cpp and doxysearch.cpp Alex On 18/11/2021 00:26, Grant Edwards wrote: > This email originated outside the University. Check before clicking links or attachments. > > On 2021-11-17, Robert Heller <he...@de...> wrote: > >> I think doxygen can create a JavaScript powered search thingy (no >> need for server-side search code). > That only seems to work for a selected list of pre-indexed strings. > > It doesn't seem like what I want to search for is usually one of the > indexed strings. > > -- > Grant > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://eur02.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.sourceforge.net%2Flists%2Flistinfo%2Fdoxygen-users&data=04%7C01%7Cfincha%40live.lancs.ac.uk%7C92fe81a359ad4e42c90e08d9aa2a6674%7C9c9bcd11977a4e9ca9a0bc734090164a%7C0%7C0%7C637727922401702780%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C2000&sdata=250fBMdYIgx%2FTbBuFPx3SMz01PFPDStgqQvcSVHHeiM%3D&reserved=0 |
From: Grant E. <gra...@gm...> - 2021-11-18 00:26:36
|
On 2021-11-17, Robert Heller <he...@de...> wrote: > I think doxygen can create a JavaScript powered search thingy (no > need for server-side search code). That only seems to work for a selected list of pre-indexed strings. It doesn't seem like what I want to search for is usually one of the indexed strings. -- Grant |
From: Robert H. <he...@de...> - 2021-11-17 21:43:05
|
I think doxygen can create a JavaScript powered search thingy (no need for server-side search code). At Wed, 17 Nov 2021 18:41:40 -0000 (UTC) Grant Edwards <gra...@gm...> wrote: > > Is there any way to get doxygen to generate a single html page? > > I find it very frustrating to have to spend time clicking through > dozens and dozens of pages looking for something rather than being > able to search for it using the browser's "find" function. > > I suppose I could go the LaTeX -> PDF route, but then you end up with > fixed-width paragraphs. > > Is the only option to generate XML and write my own XLM -> HTML > converter? > > -- > Grant > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > > -- Robert Heller -- Cell: 413-658-7953 GV: 978-633-5364 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
From: Jens K. <kal...@we...> - 2021-11-17 19:48:51
|
Hello Grant, doxygen is a multi-talented software which can produce HTML, man pages, xml (pre-formated) xhtml output content, and PDF for the most used compiler software (the tool which you can programming new software). But, doxygen does not generate single page at the moment. I use a tool, to merge all the created xml files into a xhtml file. But, this xhtml can be a php page (what you would - all is possible). Therefore, You only need one (ore more) template files which describe Your page look and feel. You can use this template file to create single html file. doxygen default files can be merge with: "xsltproc combine.xslt index.xml >all.xml" For me, I use this format: "xsltproc combine.xslt.php index.xml >all.php" okay, I must say, that I had "extend" combine.xslt witht the head and other html tags. But what Your output desire is, You can use the market software PHP, ASP ,,, But You should have strong knowledge in XML programming. Then: Your ideas are not open limited - You can open the Sky ! Am 17.11.2021 um 19:41 schrieb Grant Edwards: > Is there any way to get doxygen to generate a single html page? > > I find it very frustrating to have to spend time clicking through > dozens and dozens of pages looking for something rather than being > able to search for it using the browser's "find" function. > > I suppose I could go the LaTeX -> PDF route, but then you end up with > fixed-width paragraphs. > > Is the only option to generate XML and write my own XLM -> HTML > converter? > > -- > Grant > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Grant E. <gra...@gm...> - 2021-11-17 19:05:08
|
Is there any way to get doxygen to generate a single html page? I find it very frustrating to have to spend time clicking through dozens and dozens of pages looking for something rather than being able to search for it using the browser's "find" function. I suppose I could go the LaTeX -> PDF route, but then you end up with fixed-width paragraphs. Is the only option to generate XML and write my own XLM -> HTML converter? -- Grant |
From: tsuji t. <tsu...@gm...> - 2021-08-23 00:04:26
|
Hello, I am a software engineer living in Japan. Since 2006, I have translated Doxygen manual documents. But the domain server owner vanished recently. So, I now have translated up to ver.1.8.11 and the new URL is the following. https://doxygen.knowhow.jp Regards, Takahiro Tsuji |
From: Ilias M. d. RNDr., PhD. <mir...@um...> - 2021-08-18 23:29:31
|
Hello, there is a long list of doxygen using projects in https://www.doxygen.nl/projects.html . I wonder if somebody know a mixed Fortran77/90 and C,C++ project where doxygen is beeing used. Some time ago I was trying doxygen for such language mixed project ( http://diracprogram.org/doku.php ), but it was not working...maybe now Doxygen got matured ? Best, Miro |
From: Giorgio F. L. <gio...@un...> - 2021-08-04 10:18:24
|
To whom it may concern, I am using Ubuntu 20.04.2 LTS and Doxygen 1.8.17. I declared a function in C++ which has as an input parameter a std::function. One of the arguments of such std::function is a std::shared_ptr<void>. The presence of such std::shared_ptr<void> causes this warning in Doxygen: warning: no matching file member found for Here the full warning: /home/giorgio/CosmoBolognaLib/Modelling/NumberCounts/ModelFunction_NumberCounts.cpp:405: warning: no matching file member found for double cbl::modelling::numbercounts::counts_proxy_classic(std::function< double(const double, const double, const std::shared_ptr< void >)> fz, std::function< double(const double, const double)> z_error, std::function< double(const double, const double)> proxy_error, double(*response_func)(const double, const double, const double, const std::string, const double, const std::string, std::shared_ptr< void >), const double redshift_min, const double redshift_max, const double proxy_min, const double proxy_max, cbl::cosmology::Cosmology cosmology, cbl::catalogue::Cluster cluster, const double Area, const std::string model_MF, const std::string model_bias, const bool store_output, const double Delta, const bool isDelta_vir, const cbl::glob::FuncGrid interp_sigmaM, const cbl::glob::FuncGrid interp_DlnsigmaM, const double proxy_pivot, const double z_pivot, const double mass_pivot, const double log_base, const double weight) Possible candidates: 'double counts_proxy_classic(std::function< double(const double, const double, const std::shared_ptr< void >)> fz, std::function< double(const double, const double)> z_error, std::function< double(const double, const double)> proxy_error, double(*response_func)(const double, const double, const double, const std::string, const double, const std::string, std::shared_ptr< void >), const double redshift_min, const double redshift_max, const double proxy_min, const double proxy_max, cbl::cosmology::Cosmology cosmology, cbl::catalogue::Cluster cluster, const double Area, const std::string model_MF, const std::string model_bias, const bool store_output, const double Delta, const bool isDelta_vir, const cbl::glob::FuncGrid interp_sigmaM, const cbl::glob::FuncGrid interp_DlnsigmaM, const double proxy_pivot, const double z_pivot, const double mass_pivot, const double log_base, const double weight)' at line 814 of file /home/giorgio/CosmoBolognaLib/Headers/ModelFunction_NumberCounts.h In fact, if I remove the aforementioned std::shared_ptr<void> the warning disappears. Is it possible to resolve this issue? Thank you in advance, Giorgio Lesci |
From: Jens K. <kal...@we...> - 2021-07-04 04:28:30
|
Hello, I tried searching a solution for my problem, but I can't find anything. My Problem is, that doxygen for php don't handle default parameters if they a array: how can i fix this? |/** * @brief convert rgb values to hexa decimal, and return array. * @param int $red : 0 - 255 * @param int $green : 0 - 255 * @param int $blue : 0 - 255 * @param array $default * @return array */ public static function rgb2hex(int $red = 0, int $green = 0, int $blue = 0, array $default = ['r' => 0, 'g' => 0, 'b' => 0] ) : array { ... return [ 'r' => $r, 'g' => $g, 'b' => $b ]; } | screen sample: https://i.stack.imgur.com/bJhiu.png <https://i.stack.imgur.com/bJhiu.png> |
From: Burlen L. <bl...@lb...> - 2021-04-29 16:23:59
|
We are integrating Doxygen into a large existing C++ project. The project make extensive use of macros in certain inheritance hierarchies where consistency of interface and implementation are required. This seems to be causing Doxygen some trouble. The problem I'm having is that no related errors or warnings are emitted. I'm stuck, and not sure how to get some actionable info about what the problem and solution might be. Here's an example of such a macro #define TECA_ALGORITHM_PROPERTY(T, NAME) \ \ /** Set the value of the NAME algorithm property */ \ void set_##NAME(const T &v) \ { \ if (this->NAME != v) \ { \ this->NAME = v; \ this->set_modified(); \ } \ } \ \ /** Get the value of the NAME algorithm property */ \ const T &get_##NAME() const \ { \ return this->NAME; \ } For context, a link to its definition in the code base (a number of similar macros are defined there as well) https://github.com/LBL-EESA/TECA/blob/8d19be022df763e6d2c2fb8e83f56be3ef9ee897/core/teca_algorithm.h#L84 Where this macro is used in a class we want to Doxygen the use, by having a group like this: /** @name files_regex * Set a regular expression identifying the set of files comprising the * dataset. This should contain the full path to the files and the regular * expression. Only the final component of a path may contain a regex. * Be aware that regular expression control characters do not have the * same meaning as shell glob control characters. When used in a shell * regular expression control characters need to be quoted or escaped to * prevent the shell from interpreting them. */ ///@{ TECA_ALGORITHM_PROPERTY(std::string, files_regex) ///@} For context here is the use in class definition: https://github.com/LBL-EESA/TECA/blob/8d19be022df763e6d2c2fb8e83f56be3ef9ee897/io/teca_cf_reader.h#L99 The resulting Doxygen web pages however do not include any of the class methods, only the brief and detailed class description. https://teca.readthedocs.io/en/integrating_breathe/doxygen/classteca__cf__reader.html no warning or error are emitted. I've tried various Doxyfile settings, here is what I'm using ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO SKIP_FUNCTION_MACROS = YES I experimented with SKIP_FUNCTION_MACROS = NO However, with SKIP_FUNCTION_MACROS = NO any class that used the macros was dropped from the site entirely. There were many warnings issued on the class constructors about the macro not ending in a semi colon. I don't understand why macros would end in a semi colon as that's not a language requirement and makes no sense for defining functions like the macros in question here do - the appropriate terminating character is } not ;. Not sure how to work around that. My questions are: Should Doxygen be able to handle this? Does anyone know what the issue might be? If not how could we get some actionable info about the failures? Thank you! |
From: Stefan P. <ste...@gm...> - 2021-04-15 12:51:52
|
Am 15.04.2021 um 13:51 schrieb Mellencamp, William via Doxygen-users: > Doxygen-Users, > > Does Doxygen have the ability to update the comments sections in a > code file either based on another file, through GUI interface, or > through html, or is it strictly Unidirectional, Code File to > Documentation Output? > > Doxygen is a program to create documentation from comments in source code. It is a one way application: read source code => output documentation -- *Stefan P.* Top-posting: A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing? A: Top-posting. Q: What is the most annoying thing in e-mail? |
From: Mellencamp, W. <wil...@cy...> - 2021-04-15 12:37:53
|
Doxygen-Users, Does Doxygen have the ability to update the comments sections in a code file either based on another file, through GUI interface, or through html, or is it strictly Unidirectional, Code File to Documentation Output? Thanks Bill Please be advised that this email may contain confidential information. If you are not the intended recipient, please notify us by email by replying to the sender and delete this message. The sender disclaims that the content of this email constitutes an offer to enter into, or the acceptance of, any agreement; provided that the foregoing does not invalidate the binding effect of any digital or other electronic reproduction of a manual signature that is included in any attachment. |
From: Edward D. <eld...@tr...> - 2021-04-11 19:22:06
|
When I document a function with multiple @param special commands the output shows those parameters in alphabetical order rather than the order in which the @param special command occur. Is there a way to change this to the order in which those special commands occur ? |
From: Conducted F. <con...@gm...> - 2021-03-16 12:30:27
|
I am new to Doxygen but I really like its ability to read C without any IDE dependency. I'm looking to create comprehensive graph alternatives to UML using Doxygen XML output, but I don't know XML very well. Is there a resource (or source file) that could give me a leg up? My progress so far has been to use the combine.xslt to create one big XML file, which has worked but I'm at a loss of what would be next (my "attempts" history for dot conversion are here https://stackoverflow.com/questions/66407288/convert-xml-to-dot-dotml). I'm sitting on windows as well. My hope is to have one big dependency graph for file organization, but integrating call graphs and the rest of what Doxygen can do normally would also be great. If I can get just the dependency part working, the rest will come easier I would think. Having fully-combined graphs would be a future goal. I'm willing to do/learn some xslt if that's what it takes, but I need to know what Doxygen is likely to output. I may end up hiring someone to do the transformation, but something to look into would help. -Brandon |
From: Conducted F. <con...@gm...> - 2021-03-10 06:22:51
|
I am new to Doxygen but I really like its ability to read C without any IDE dependency. I'm looking to create comprehensive graph alternatives to UML using Doxygen XML output, but I don't know XML very well. Is there a resource (or source file) that could give me a leg up? My progress so far has been to use the combine.xslt to create one big XML file, which has worked but I'm at a loss of what would be next (my "attempts" history for dot conversion are here https://stackoverflow.com/questions/66407288/convert-xml-to-dot-dotml). I'm sitting on windows as well. My hope is to have one big dependency graph for file organization, but integrating call graphs and the rest of what Doxygen can do normally would also be great. If I can get just the dependency part working, the rest will come easier I would think. Having fully-combined graphs would be a future goal. I'm willing to do/learn some xslt if that's what it takes, but I need to know what Doxygen is likely to output. -Brandon |