Discussion of article "Creating Documentation Based on MQL5 Source Code"

New comment
 

New article Creating Documentation Based on MQL5 Source Code has been published:

This article considers creation of documentation for MQL5 code starting with the automated markup of required tags. It also provides the description of how to use the Doxygen software, how to properly configure it and how to receive results in different formats, including html, HtmlHelp and PDF.

Our aim is to create a help/presentation file based on the already written code located in one or more files with a ready markup. As a result, we will receive a file in the chm format. In addition, we will create html files, which can also be suitable for presentation or reference purposes. We will use the Doxygen software, which is suitable for the above task.

Author: Andrei Novichkov

 

I have a question, not exactly about the article, but about Doxygen. I understand that you used version 1.8.13. I use it too, but directly - via command line. For some reason, in the html help I get, all the "Directory Reference" pass-through pages don't show the subfolders they contain. I mean, for example, there is such a folder structure: MQL4, with the usual subfolders Include and Scripts. If you click on the File List item in the documentation menu, you will see a normal tree with folders and files. If you click on the Include folder, for example, you will see the "include Directory Reference" page with all the files. However, if I click on the higher level - MQL4 - I get the page "MQL4 Directory Reference", which has a subheading Directories, but under it there is neither Include nor Scripts. Other docs, including yours, do not have this problem. What can be the problem?

I have already tried filling INPUT in the config in different ways, I thought it was the first candidate for misconfiguration, I changed RECURSIVE - but nothing helps - the documentation is always created in everything normal except for this annoying nuance.

 
Stanislav Korotky:

I have tried filling INPUT in the config in different ways, I thought it was the first candidate for incorrect configuration, changed RECURSIVE - but nothing helps - the documentation is always created in everything normal except for this annoying nuance.

Took your config. It generates help for my sources without the described problem. Now I have to compare a dozen options here and there ;-/

 
Stanislav Korotky:

I took your config. It generates help for my sources without the described problem. Now I have to compare a dozen options here and there ;-/

Just in case I'm writing the result - may be useful to someone. It turned out that EXTRACT_ALL affects it. With NO the folders are not displayed, with YES they are displayed. IMHO, a bug of the generator.

 

Good afternoon.

I'm probably too late to reply ))))))) I recall that in the Doxygen GUI there is an option to tick "including subdirectories". I don't remember very well where that is anymore, but it's possible to find it.

New comment