I am trying to document some MATLAB code using Doxygen, but it is only reading comments from the top of the file. I am using this github repo for converting the MATLAB to be readable by doxygen: https://github.com/simgunz/doxymatlab.
I would like to create sections of documentation mixed in with sections of code to explain how the code works and the equations it is based off of. Does anyone know how to do this? It appears that Doxygen is normally able to do this, so I am not sure if I have done something wrong setting up Doxygen in my project or if the matlab parser I am using prevents this.
%>#file file_name.m
%>#brief file description
%>
%>Doxygen picks up this comment
%>
*Some MATLAB code*
%>Doxygen does not read this comment
Thanks for the help.
Related
I'd like to read specific user inputted comments between <tx> tags in an MDF/MDF3 file with python. Is this possible using asammdf or mdfreader?
Parsing through the file the 'pythonic' way is giving gibberish results for some files
You should look at the comment attributes of the blocks that are interesting to you. See https://asammdf.readthedocs.io/en/latest/api.html#mdf-version-2-3-blocks
Can you give an example of what TXBLOCK needs to be parsed? A MDFValidator screenshot would be nice too.
in a textbook, examples on the book companion website are given in Maple, using a .mws file format.
I do not have Maple but I am interested in studying the code of the examples.
I wonder if there is a conversion tool for Linux that allows me to export to text or at least to view the content of the script.
I am aware there exist a free Maple player but from the product description it is not clear if it allows to see the script content or just "play" with the inputs it defines.
I did also try this Maple-to-Python converter, but it's very alpha and it just doesn't work.
The Maple Player should definitely be able to open any .mws file. You won't be able to run commands, but you can at least read the code contained in the file.
Maple itself can export .mws files to text, but other than that, I haven't heard of any other converters for extracting the code from these files.
To distinguish this question from Doxygen: Adding a custom link under the "Related Pages" section which has an accepted answer that is not a real answer to the question, I specifically add prewritten to the question.
What I want:
Write one document tex file (without preamble, since this file will be \input-ed into a full document)
Import the document into Doxygen's HTML output.
Using Doxygen to produce tex file will probably not work, since it does too much layout work [This holds for its HTML output too like empty table rows 2015]. If Doxygen takes some other input that can easily be transformed into LaTeX, that will do.
You can easily add an already existing Latex file to your doxygen documentation using \latexonly\input{yourfile}\endlatexonly.
I would assume you put it e.g. under a doxygen \page.
I'm trying to document a C API which is all contained in a single C Header file. When I run doxygen, on the file, it's giving me errors for currently undocumented C Macros, but when I add the necessary documentation for macros, although the undocumented errors are cleared, the macros plus documentation do not appear in the doxygen generated html output.
Only a fraction of the documented header file, the structures, actually appears in any doxygen output. I can't see anything in configuration settings or documentation that would assist in clarifying why doxygen does not place documented code from the header file into its generated output.
Does anybody know why this would be the case?
See items 2 and 3 of the FAQ: http://www.doxygen.org/manual/faq.html
In short you are likely missing a comment block with #file to document your header file.
I have found the source for a game that I am interested in modifying, and it's in the form of doxygen "documentation".
Under "files" I get html files with names not related to the cpp and h files, and also line numbers.
I was wondering if there is a way to convert the doxygen documentation into regular cpp and h files.
How many files are there? If not too many, a manual copy-paste perhaps...
html2text is a python program that is pretty good at converting html to, well, text.