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 somewhat of a standard out there that people use to document their libraries and frameworks?
Ideally, it would make use of JSON or YAML and would allow for generation of HTML pages that present it nicely.
The most common approach to SDK documentation is to generate the docs from the comments in the source code. This way the class/function reference docs can be easily kept in sync with the implementation.
There are documentation generators for different programming languages and frameworks. Some tools let you combine the generated reference docs with manually written conceptual topics (overview, "getting started", etc.)
Some popular tools are:
.NET - Sandcastle
Example: Sandcastle docs
Java - Javadoc (part of JDK)
Example: Java API docs
JavaScript - jsdoc
Example: Adblock Plus JSDoc
Python - Sphinx, specifically sphinx-apidoc
Example: Python docs
Doxygen supports C/C++, Objective-C, C#, Java, PHP and some other languages
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 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.
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
Details on the packages/types is in the Scala API documentation on scala-lang.org. But that's organised by class and I (as a Scala neophyte) find it difficult to locate the exact data type I need and work out what operation are supported on what (especially in the huge and powerful scala.collections.* tree).
Is there an online or dead-tree resource that either presents this reference information more usably, or guides the reader through the library?
Alternatively, maybe I just need to be informed how to use the existing Scala API doc website more effectively.
Any advice on effective use of the standard Scala library gratefully received!
For the collections in particular, there's a very good overview available here: http://www.scala-lang.org/docu/files/collections-api/collections.html
Written by Martin Odersky himself :)
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
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 6 years ago.
Improve this question
I'm a jack-of-all-trades-master-of-none programmer and as I jump around languages, quality consistent documentation is becoming more and more important to me. I've recently been using Doxygen, but Wikipedia reveals the usual ridiculous list of similar frameworks.
What is your favorite documentation generator and why? (Vote where you agree to keep it tidy!)
I use different files written in MediaWiki MarkUp, since this is easy to learn for everyone. I convert this to HTML and a CHM file, and to LaTeX for the PDF documentation.
This was the most painless way for me to generate Online documentation AND printable documentation in one strike with a simple way of input.
The tools I use are org.eclipse.mylyn.wikitext with a custom DocumentBuilder for LaTeX, the Microsoft Help compiler (which sadly only runs on windows), and a LaTeX distribution.
EDIT: I managed to get the Microsoft Help compiler running with Wine, so my Linux build server is now able to create the whole documentation automatically.
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
Where is the documentation for NUnit's mocking library, NUnit.Mocks?
I can't find anything in their official documentation or wiki.
As I have been told recently Nunit.Mocks are not meant to be used for serious applications. Given it's obvious limitations you're better off with a different framework anyway...
NUnit.Mocks was originally developed for internal use in NUnit's own
tests, although we no longer use it for that purpose.
In addition, it has been useful as a teaching tool, allowing users to
gain familiarity with mocking techniques before moving on to more
serious frameworks.
For production use, we recommend you install a full-featured mock
object framework.
The NUnit project now uses NSubstitute and NUnit.Mocks is no longer
being developed.
Source: NUnit.Mocks 2.6.2