Documentation that focuses on code itself, such as its function, correct use, expected output, relationship to other code as well as database and tables connections, and usage examples.
Questions tagged [code-documentation]
381 questions
3
votes
1 answer
Should I document the current context and scope too
I am currently writing an arc42 specification document for an application that is supposed to replace several convoluted manual processes.
In the documentation as well as the examples I noticed, that "Context and Scope" normally only includes the…
Andre Wruszczak
- 35
- 3
3
votes
0 answers
Creating subsections in pkgdown function reference page (R)
How is it possible to create not only first-level but also second-level headers in function reference page of R package documentation created with pkgdown?
Can I do this by modifying the _pkgdown.yml file?
More details:
An example of an R package…
GegznaV
- 4,938
- 4
- 23
- 43
3
votes
1 answer
How to add code snippets to python docstring (not as doctest)?
I would like to provide code snippets to show-case how one could use a particular method or class in python. How can I do that?
In Java one could use
...to do so. Doctest is the only way? As I look at the existing docstrings for…
Azim
- 1,596
- 18
- 34
3
votes
0 answers
auto documentation system for R shiny
I ask for any advice how to do documentaion / auto-documentation for larger shiny applications.
R packages have roxygen2, but are there any equivalents of auto-documentation for shiny server and ui code?
I'm working on a developing project of +15k…
Soren Havelund Welling
- 1,823
- 1
- 16
- 23
3
votes
2 answers
How do I document an object with JSDoc?
What's the best way to document the source code of a simple JavaScript object (and its export) using JSDoc?
For example, I want to document the following object:
/** how do I JSDocument object baseAdder? */
const baseAdder = {
/** how do I…
P. Bofs
- 61
- 1
- 5
3
votes
0 answers
Rider: change documentation comments template
Is it possible to change template for "summary" comments in Rider? When I'm typing "///" it generates summary comments like this:
///
///
///
///
///
///…
BoJIHa npocmombI
- 195
- 1
- 7
- 22
3
votes
2 answers
Development Documentation
We are a development team and we need to document our code.
Each developer works on a part of the code which can be called as a module.
We need a documentation that has this specification
It should be easy to implement and use
Each developer…
user560224
- 31
- 1
3
votes
1 answer
Why can't I reference the accessible members in a base class from within XML documentation comment tags in a derived class?
Say I have this:
internal abstract class Animal
{
internal bool IsExtinct { get; set; }
}
internal sealed class WoollyMammoth : Animal
{
internal int WeightLbs { get; set; }
///
/// Construct a new instance with
rory.ap
- 34,009
- 10
- 83
- 174
3
votes
0 answers
Why does Xcode not show my custom documentation in the autocomplete popup?
I'm using Xcode 8.1, a simple Swift app with a custom class. I added documentation using ///, but it is not showing in the autocompletion popup.
However, it does show in the Quick Help sidebar and the Quick Help popup so the documentation is…
Mark
- 6,647
- 1
- 45
- 88
3
votes
0 answers
Doxygen php with embedded javascript
I use doxygen to document PHP-code and Javscript-code. That works great for plain language files, but not for main-web-php files containing embedded Javascript. Several options I have tried but none is working correctly. Have anyone a splendid…
Harm
- 787
- 7
- 11
3
votes
0 answers
Link to method in Xcode documentation comments
Can you create a clickable link to an Objective-C method in Xcode documentation comments, for example, in a \see section?
iosdude
- 1,131
- 10
- 27
3
votes
2 answers
pycharm quick documentation (CTRL+Q) not loading local documented file
I'm using pycharm 2016.1.
I have a function documented as follows:
def extract_filename(filepath, ext=None):
"""
This function returns the filename from a complete filepath including its extension.
If ext is set to an extension it is…
Juliano Foleiss
- 110
- 1
- 8
3
votes
1 answer
Lombok documentation and interface in Java
Normally in Lombok the documentation that shows up in getters and setters are inherited from the field. But I have a class that needs to have an interface. In Java interfaces do not have fields and so I must define the fields in the concrete class.…
Nouvel Travay
- 6,292
- 13
- 40
- 65
3
votes
1 answer
How to include external file as Sphinx documentation similar to a code block?
How to include external file as Sphinx documentation similar to a code block?
And how can I make it style the syntax color?
user805981
- 9,979
- 8
- 44
- 64
3
votes
1 answer
Use pandoc as documentation generator
I saw in a wikipedia page (Comparison of documentation generators) that pandoc can be used as a Documentation Generator (like doxygen does).
But I didn't find in pandoc's documentation or in it's site a way to extract documentation from source code…
Seninha
- 329
- 1
- 12