How do documentation generators work? [closed] - documentation

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I'm trying to understand how documentation generators like Doxygen, JavaDocs etc. work. Please don't get me wrong, I'm not asking how to use them, but how they do it. I tried to find information about the topic but only found 1 article which is really old, so I'm kinda frustrated.
Does someone know any articles or literature about this?

For doxygen there is a manual page about the internals of Doxygen.
Some small document generators just use regular expressions to extract the documentation. The more flexible and complicated way is to develop a parser for the language and a parser for the documentation syntax just like doxygen and Javadoc do.

Related

Incomplete Frege Documentation [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
The javadocs at http://www.frege-lang.org/doc/index.html seem to be missing quite a bit (namely, no frege.prelude package), and does not seem very up to date. Might there be a good documentation for Frege hidden in plain sight somewhere?
What you have seen is the API doc of the runtime classes, which is really minimal since the typical Frege user will not work with those.
Thomas correctly pointed to the library documentation.
In addition, there is "Hoogle" support for Frege: http://hoogle.haskell.org:8081/ where you can search the API.
All is linked from the Frege home page.
Hope that helps.

Cheatsheet for Markdown and Restructure syntax comparision? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there a cheatsheet that compares the usage of Markdown with Restructure? With this, I could learn rst faster if I already knew Markdown. I tried google for it but haven't found one..
A small comparsion from a lot lightweight markup language syntaxs can be found on Wikipedia.
There is also a Gist document about the common markup between the two languages.
You can use Pandoc to convert your existing Markdown to reST or the other way around.
There are a lot of different Markdown dialects, so it may be difficult to compare the syntax with reST.

How to create programming flowchart/documentation from VB.NET source code? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
what tools do you use to create programming flowchart/documentation from VB.NET source code? There are absolutely no comments/documentation at present. I am a beginner, i.e. I tried Sandcastle but it is way over my head and could not get it going, not even with GUI.
Fatesoft's CodeVisual To Flowchart is OK but it is almost the same as the code and I still don't understand the code.
Convert VB.NET to Csharp using http://converter.telerik.com/
Use Code Rocket to both generate documentation and flowchart http://www.rapidqualitysystems.com/Products/CodeRocketNET
You can use the built-in XML documentation, described here
I have always enjoyed the output of doxygen
And now I read that you need it for VB .... sigh
I guess you can look at it and think about how awesome it would have been to use ;)

Where is the documentation for wxAUIToolbar? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I looked in http://docs.wxwidgets.org/trunk/ but could't find the documentation for it.
Does anyone know where it is and/or why it's not there?
I can explain why it's not there in a sense - there's no Doxygen annotations in the header file where the class is declared. As for why not, I'm guessing that the AUI authors isn't a big fan of Doxygen - I believe AUI was developed as a third party addition to wxWidgets, and has only relatively recently been merged in, so a few differences in things like this are to be expected.
The class is declared in include/wx/aui/auibar.h, it inherits wxControl, and from a quick look through the public methods it's probably not that hard to figure out.
There are some wxAuiToolbar examples in the aui sample program (samples/aui/auidemo.cpp). This should give a few more clues.
Until someone contributes some documentation updates, I'm afraid a bit of detective work is probably needed.

JScript Documentation [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Note: NOT Javascript. :-)
Hello,
I just had a random thought, and have decided to learn more Jscript. I know the basics, I'm proficient in HTML, XML and C++ BUT, there doesn't seem to be much docs on Jscript. The official MS Documentation for JScript contains a WHOPPING ONE WHOLE PAGE about web-page development in Jscript! And that page, is useless.
Is this the right documentation? I downloaded it from Microsoft's website. I have no idea where to go for descent docs related to Jscript, nothing on Gooogle, nothing in book shops, nothing anywhere.
Have you seen these detailed docs? They look quite comprehensive to me.
There are additional pointers to information in the references of the Wikipedia article.
There also seem to be several books available.