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
23
votes
5 answers
JSDoc - how to document prototype methods
I've been trying to document the following code using JSDoc:
/**
* @module person
*/
/**
* A human being.
* @class
* @param {string} name
*/
function Person(name){
this.name = name
}
Person.prototype = new function(){
var…
Kuba Orlik
- 3,360
- 6
- 34
- 49
21
votes
1 answer
How to add formatting such as bold, italic, underscore, etc. to Kotlin documenation (KDoc)
I found the page Documenting Kotlin Code in the official Kotlin Reference.
Yet, I could not find out how to highlight certain parts of the documentation, e.g., marking it as italic or bold.
I am new to Kotlin, coming from Java, and have previously…
Markus Weninger
- 11,931
- 7
- 64
- 137
21
votes
2 answers
Where is the documentation of Selenium Webdriver for NodeJS?
I don't seem to find any, the only one I always find is this one:
https://code.google.com/p/selenium/wiki/WebDriverJs
But it is more a guide. Not a documentation of all functions. It lacks for example the documentation for Webdriver.Window, or…
justGoscha
- 24,085
- 15
- 50
- 61
19
votes
2 answers
Why would it be illegal to inform about “abort”?
The GNU libc documentation of the abort function contains the following notice:
Future Change Warning: Proposed Federal censorship regulations may prohibit us from giving you information about the possibility of calling this function. We would be…
Konrad Rudolph
- 530,221
- 131
- 937
- 1,214
17
votes
2 answers
What is compiler warning CS1723 "XML comment has cref attribute 'T' that refers to a type parameter" all about?
Given this code:
///
/// Implementations represent a configuration with a specific data
/// type
internal interface IConfiguration
{
}
I'm getting a compiler warning…
rory.ap
- 34,009
- 10
- 83
- 174
15
votes
4 answers
Visual Studio XML summary comment on single line
In Visual Studio, how do I change the default XML summary comment snippet from three lines to one line?
Currently it provides this snippet when I type ///:
///
///
///
I would like this shorter…
Eugene
- 10,957
- 20
- 69
- 97
15
votes
1 answer
Dart - Mark as Deprecated Documentation
I changed something in my implementations and I want to mark some classes deprecated, so that they will use the new implementations instead.
How can I mark a class as deprecated in dart? For now I only document it as deprecated without actually…
Zolicious
- 797
- 7
- 16
15
votes
1 answer
How can I force Doxygen to show full include path?
How can I force Doxygen to show full include path?
What do I mean:
I have a class foo::bar::bee defined in bee.hpp in following directory structure:
foo
foo/bar
foo/bar/bee.hpp
Doxygen, when it documents foo::bar::bee class tells that you need to…
Artyom
- 31,019
- 21
- 127
- 215
14
votes
1 answer
perl6 signatures in POD
since --> is the preferred way to state the return type in a signature in perl6 I am wondering if or how it is possible to put the code of a function signature into C<...>.
e.g. C Bool)>
Martin Barth
- 796
- 4
- 13
14
votes
2 answers
Where can I find an overview of the syntax of the Neo4j GRASS language?
Neo4j's browser allows the graphs it shows to be styled using a CSS-like style file in the GRASS language (GRaph Style Sheet). However, I have not been able to find the syntax of this language. Is there any and if so, where can it be found?
equaeghe
- 1,644
- 18
- 37
14
votes
3 answers
How to document return in JavaScript
I'm writing my own library for the project at work for a browser application and I am having the same old problem deciding how to comment the code.
I'm trying to follow the JsDoc syntax, but will probably continue the Google Closure Compiler way. I…
Azder
- 4,698
- 7
- 37
- 57
13
votes
1 answer
Does anyone have the "Documentation URL"s in PyCharm for the following libraries:
I'm a fan of the "quick documentation" feature of PyCharm & other Jetbrains IDEs, but it needs to know the specific "Documentation URL" for each library, that gets set under Preferences > Tools > Python External Documentation settings.
I was…
retnuH
- 1,525
- 2
- 11
- 18
13
votes
5 answers
Xcode Quick Help displays "No Quick Help" when viewing a single file
The quick help feature is working just fine when I open an Xcode project, however when opening a file (e.g. abc.swift) that's not in an open project, the documentation does not appear.
Here is an example:
iShaalan
- 799
- 2
- 10
- 30
13
votes
1 answer
How to include documentation in DLL to show method summary in Unity3D?
I'm working on a C# DLL plugin for Unity3D. Actually, the MonoDevelop tooltips (or Visual Studio) show only the structure of my method:
But it doesn't show my summary like this:
Even if I documented my code:
Is there a way to include my…
probitaille
- 1,899
- 1
- 19
- 37
12
votes
2 answers
Is there a way to reference const parameters in C# block comments?
In the c# block comments, I want to say that the default value for a particular parameter is a class const property. Is there a way to reference that parameter directly?
I'd like to either display the value in the generated documentation, or link…
Chris Reyes - he-him
- 471
- 4
- 15