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
2
votes
1 answer
Ruby methods for element reference and assignment
I'm reading the docs for Ruby 2.5.0 and I don't understand this part about the Methods:
Additionally, methods for element reference and assignment may be
defined: [] and []= respectively. Both can take one or more arguments,
and element…
John S.
- 33
- 5
2
votes
1 answer
Visual Studio Team Services how to publish code documentation
My intention is to improve the code documentation of our Visual Studio C# solutions. Therefore I want to upload the xml-based C# documentation to Visual Studio Team Services.
Option 1: Doxygen
there is a package for doxygen, which can be added to…
Frank
- 21
- 1
2
votes
0 answers
How to document emitted Qt signals in doxygen?
I know that a signal is just a function so the issue is not with documenting the signal itself. Imagine the following body of the function bar():
void MyFooBar::bar(int x) {
if(x < 0) emit fooLess();
else if(x > 0) emit fooGreater();
else emit…
rbaleksandar
- 8,713
- 7
- 76
- 161
2
votes
1 answer
Lua Ldoc documentation of a table
I want to document a table using Ldoc. The documentation states that
Ok, this looks good but when I apply the formating to my table:
--- A table of mappings between NodOn remote scene codes and a text description.
nodonSceneTableVerbose = {
…
Fredrik Karlsson
- 485
- 8
- 21
2
votes
1 answer
.. literalinclude:: from markers
I am using python-sphinx for documenting a C code. I am not interested in features offered by doxygen, however I sometime would like to include some snippets from the code-base.
The .. literalinclude:: looks great, but the :lines: option is a bit…
nowox
- 25,978
- 39
- 143
- 293
2
votes
1 answer
The correct place for class-implementation documentation notes in Java
Suppose I’m writing some complicated class in Java, and I want to document some things regarding the implementation of the class (i.e. things that shouldn’t interest the users of the class, but rather a programmer wishing to modify the actual…
Ofer
- 293
- 3
- 9
2
votes
0 answers
Are there tools to document Web UI standards across all applications?
We want a way for all our .NET developers to follow a consistent standard when building web UI in terms of javascript, html and CSS. For example all confirmation, warning and errors messages should have the same look and feel. Plus have a way to…
Chaka
- 1,709
- 11
- 33
- 58
2
votes
2 answers
Create context-sensitive help for a component in Lazarus
We want to make documentation for some new components in Lazarus.
Chm documentation files are already available, and we just need to somehow integrate them with Lazarus.
This help system should be context-sensitive, that is after F1 key was pressed…
Masood
- 685
- 2
- 8
- 16
2
votes
1 answer
Document method-summary with ambigious reference
I have a massively overloaded method MethodA which is referenced by the summary-tag within my documentation of MethodB:
/// A link to
void MethodB { ... }
The comment should not only rely to a special…
MakePeaceGreatAgain
- 35,491
- 6
- 60
- 111
2
votes
1 answer
Does a Tool for Automatically Visualizing a Project's Source Code's Control Flow In-Line Exist?
I would like to be able to use a tool that lets you visualize a program's control flow(s) in the context of its source code. To clarify, such a tool should basically show what happens in a program by spitting out a human-readable abstract…
RandomDSdevel
- 431
- 6
- 17
2
votes
2 answers
What method is used for generating the Android ID on ADB
When I connect my device to Android Debug Bridge (ADB) over USB using this command:
> adb device
then I get the following (encrypted) 16 characters:
df23582e162esfd2 device
What are these characters? Are they generated by Windows or ADB? Are…
Amor Lov
- 41
- 6
2
votes
1 answer
Code documentation stopped working in Xcode 6
I waited until 6.0.1 to switch to Xcode 6. Upon opening one of my project, I noticed that the quick help view of a method or variable's documentation doesn't work anymore.
For example a simple:
/*! Value of the property. */
for a @property just…
Didier Malenfant
- 729
- 1
- 10
- 25
2
votes
0 answers
Autogenerating documentation from gcc preprocessor
I have some C code which has static initializers with values that are derived from macros. These intializers are essentially my code's external API. I am looking for a way to autogenerate documentation for my code so that the initialization values…
Paul Grinberg
- 1,184
- 14
- 37
2
votes
1 answer
Objective-C syntax in doxygen markdown pages
So I am trying to have a documentation guide page for my doxygen generated documentation documentation for my objective-c project, but it doesn't seem to work.
~~~~~~~~~~~~~~~{.m}
/**
This is the private interface of class.
*/
@interface…
Shawn
- 667
- 8
- 19
2
votes
1 answer
Code documentation outside code file
For some reasons, i want to document an API but I don't want to write the documentation directly inside the source code as it is now widely done. I'm looking for a documentation generator tool which could take as input a documentation file and be…
Valentin Perrelle
- 1,303
- 1
- 10
- 17