In theory JSON Schema could serve this purpose, but in practice I am not sure it does. Worth mentioning I hope. Other than this, my personal opinion is that since JSON is predominantly used for transferring objects, documenting equivalent objects in language client uses (Java, C#, various scripting languages) may make most sense — after … Read more
I personally use the following code in a “dataManagement” package I call in all my scripts. It has roxygen documentation and examples. You actually simply call document() and have doxygen ran on the C code, in src/ . The doc is put in inst/doxygen So that your package is CRAN ready. The R documentation being … Read more
You can obtain a PDF copy of the C99 standard (ISO/IEC 9899:1999) from ANSI (and other fine standards organizations) for your private use for a modest fee – I believe it was 18 USD when I bought mine. Having that available is invaluable to me. But if you find a copy in public, then it … Read more
Use class-level PHPDoc comment — specifically @method tag — works fine in PhpStorm: /** * @method static someClass get_by_user_id(int $id) Bla-bla * @method static someClass get_first_by_id(int $id) */ abstract class a { … In the above: @method — PHPDoc tag static — tells that this is static method someClass or $this — return type get_by_user_id … Read more
You have to type \link[pkg]{function} e.g. \link[stringi]{stri_c}
Python has a PEP (257) that defines Docstring Conventions. Regarding documentation of attributes, it states: String literals occurring immediately after a simple assignment at the top level of a module, class, or __init__ method are called “attribute docstrings”. So the following are considered documented attributes: class Foo(object): velocity = 1 “””Foo’s initial velocity – class … Read more
Even if they don’t exist in Javascript, I found that JSdoc understands “generic types”. So you can define your custom types and then use /* @return Promise<MyType> */. The following result in a nice TokenConsume(token) → {Promise.<Token>} with a link to your custom Token type in the doc. /** * @typedef Token * @property {bool} … Read more
I want to offer an update on the current status of the Pinterest API. There is still no public API available. Pinterest also does not seem to be approving anyone who applies for access on their site. As of right now, the endpoints of the Pinterest v3 API are almost complete although there is no … Read more
The doxypy input filter allows you to use pretty much all of Doxygen’s formatting tags in a standard Python docstring format. I use it to document a large mixed C++ and Python game application framework, and it’s working well.
You can do this quite easily using the Microsoft Sandcastle (or NDoc) inheritdoc tag. It’s not officially supported by the specification, but custom tags are perfectly acceptable, and indeed Microsoft chose to copy this (and one or two other tags) from NDoc when they created Sandcastle. /// <inheritdoc/> /// <remarks> /// You can still specify … Read more