documentation
How should I provide YARD/RDoc documentation for Ruby keyword arguments?
Should I just continue to use the @param keyword? Yes. YARD recognizes keyword arguments. Use @param to document a single method parameter (either regular or keyword) with a given name, type and optional description: # @param query [String] The search string # @param exact_match [Boolean] whether to do an exact match # @param results_per_page [Integer] … Read more
How do you document your database structure? [closed]
MySQL allows comments on tables and rows. PostgreSQL does as well. From other answers, Oracle and MSSQL have comments too. For me, a combination of UML diagram for a quick refresher on field names, types, and constraints, and an external document (TeX, but could be any format) with extended description of everything database-related – special … Read more
Why Doesn’t jQuery use JSDoc? [closed]
I’ll take a shot in the dark here since I can’t speak for the jQuery team of why I wouldn’t use JSDoc. JSDoc, at least the last time I checked, didn’t have any clean way to support method overloading (or parameter shifting…whatever name you want to give it here) and jQuery uses this all over … Read more
Where can I browse the sourcecode for libc online (like doxygen)
You should check if your distribution is using the vanilla GLIBC or the EGLIBC fork (Debian and Ubuntu have switched to EGLIBC EDIT: they switched back around 2014). Anyway, the repository browser for GLIBC is at http://sourceware.org/git/?p=glibc.git http://code.woboq.org/userspace/glibc/, posted by @guruz below, is a good alternative. The source is a bit complicated by the presence … Read more
Annotating Methods in Delphi?
The feature is named XML Documentation Comments and is documented here. It appears to have been modelled closely on the equivalent .net feature so you should be right at home with it. The documentation contains this example: /// <summary> Removes the specified item from the collection /// </summary> /// <param name=”Item”>The item to remove /// … Read more
What does % do to strings in Python?
It’s the string formatting operator. Read up on string formatting in Python. format % values Creates a string where format specifies a format and values are the values to be filled in.
auto-document exceptions on methods in C#/.NET [closed]
The long and the short answer is that this isn’t possible. Unlike Java, none of the .NET languages require that functions report a list of possible exceptions that can be thrown (which means that you either have to catch or report any exceptions that could be thrown on functions that it calls). Because of this, … Read more
How do you read JavaDoc? [closed]
JavaDoc jar can be unzipped directly. In theory any released javadocs can be downloaded and viewed offline. download directly from maven repository. For example: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar Now you get objectify-5.0.3-javadoc.jar, rename the file to objectify-5.0.3-javadoc.zip use your favourite unzip tool to extract it, now you have a folder objectify-5.0.3-javadoc double click index.html will open the index … Read more
RESTful web service API documentation with Sphinx [closed]
The Sphinx Contrib project also seems to have an HTTP Domain package for documenting RESTful HTTP APIs. You can find its documentation on the Python packages site. I can’t speak to its fitness: I’m only just starting to look into Sphinx, and I have a need to document RESTful APIs as well, and noticed this … Read more