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.
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 8 years ago.
Improve this question
As I am new in Swift, quite often when I want to do a basic thing, I "recreate" functions which have actually already been created (built-in functions: sort, equals, find, contains, etc.) so I was wondering if you had a link with all those functions details and explications (with examples as well would be awesome!)
I found this but it's quite old (june 2014) and not everything is documented.
You can see everything that Swift provides “out of the box” by typing the name of a Swift built-in (like String), then command-clicking it. Example:
This takes you to a generated file declaring all of Swift's built-in types and functions. (The file does not exist in the Xcode bundle. It is generated on demand in memory from the file Swift.swiftdoc, which exists in several places in the Xcode.app bundle.)
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 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 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 5 years ago.
Improve this question
I'm thinking of making a D interface to Valgrind's client request API. By mucking around in the header files and de-compiling stuff, I could eventually figure out what it's doing but I'm wondering if their is a authoritative document on how things work? (BTW I already found this document but it doesn't have enough info)
What I'm looking for would answer questions like: How do I generate the macros to wrap/call a function that returns a 32bit machine word and takes a 64bit float?
In the valgrand manual, it describes the existing client request prototypes at the bottom of http://valgrind.org/docs/manual/manual-core-adv.html but none of these support passing 64bit floats. You could split it into two longs and pass it that way. It does look pretty hairy.
The authoritative document on how it works is the source code. If the tech docs are incomplete, then use the source.
I would also suggest looking at the sources of libraries that use the client request mechanism.