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 looking for resources on various code/API documentation syntaxes, such as Javadocs. Are there any other widely used documentation syntaxes? I'm specifically looking for those used in association with C, C++/Objective C/Cocoa, Shell Scripts (if any) and Java, with PHP/Ruby/Python and the like being a second priority.
Thanks for any help.
P.S. - Do people use Javadoc syntax in C/C++/Objec-C projects, or not so much?
A lot people use Doxygen which understands C++, C, Java, Objective-C, Python, Fortran, VHDL, PHP, C and more.
Doxygen has its own syntax but can also be used with JavaDoc, the MS-XML-Commenttags or the Markdown-Syntax. The OpenOffice uses f.ex. doxygen for it's API-documentation with the JavaDoc syntax, because it can be used for Java- and C-sources.
Related
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've been programming in common lisp for a while now, and I like how there's so much handy documentation on the language online; the problem is that I'm often offline and can't access it when I need it most.
Is there a PyDoc equivalent for common lisp (or even just man pages for the language) that I can download and use in the shell?
Cheers in advance.
You can download the CLHS and install it in various ways.
http://www.cliki.net/CLHS
that's an old question…
edit: as referenced on the Cookbook, we can read the HyperSpecs offline with either Dash (MacOS), Zeal (GNU/Linux) or Velocity (Windows).
we could ask or add it on devdocs: https://devdocs.io/
and take the data of the CL Ultra Spec: website, data
and of course browse the built-in documentation with Emacs (C-h, see the menu).
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.
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
Probably I just can't find the magic words for google, but I just can find the documentation on how to use the code directive in restructuredText with the supported languages.
The supported languages can be found here: http://pygments.org/languages/ but I need to know what each [language] translates into in the following code snippet:
.. code:: [language]
{code here}
For instance
.. code:: bat
{code here}
seems to be windows batch files.
Where is this documented?
I don't know any place where this is documented, however looking at the docutils code shows that docutils uses pygments.lexers.get_lexer_by_name() to find the right lexer.
This function takes the short names of the lexers given in pygments lexers.
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 anything like Javadoc for documenting Fortran code? How does one document the API for the many functions they have so that they can find what they want more easily?
Not "standard", but I've used a program called "robodoc" that is able to work with Fortran.
Nowadays I believe Doxygen supports Fortran as well, which IMHO is a better tool than robodoc.
As janneb mentioned "robodoc" is clean, easy and hence useful. But you it will not analyze your program and you have to do everything yourself. On the other hand, Doxygen have incorporated the modern Fortran features(derived data types, type bound procedures, ... ) and just like C++ you can get an analysis of your program along with graphs etc.
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
Are the JavaDocs for clojure.lang, etc. available online? Do I need to build it myself from the Clojure source?
Thanks.
if you want descriptions for functions and even examples, visit ClojureDocs
you can even contribute ;)
Javadocs don't exist, per se. If you look at the Java source code, it's very sparsely documented. Certainly you could generate a skeleton yourself, but it probably wouldn't be all that useful anyway as much of the language is self-implemented (in clojure), using Java mostly for bootstrapping the core functionality. I don't think clojure.lang package is really intended to be used directly.
To learn about Clojure functions you can:
Use (doc) and (find-doc) from a repl
Use the API reference at clojure.org
See ClojureDocs, per #Belun's answer