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
0
votes
2 answers
Class highlighting in documentation comments
I am using MS Visual Studio 2015 and I am trying to do some documentation and description of methods I made. I use the /// comment and would like to highlight exception class names in IntelliSense popup. So I would like to get result like ... does…
Rao
- 802
- 8
- 19
0
votes
1 answer
How to get mail when a program test is failed in Coded UI test with Microsof Visual Studio?
I've created many test cases. I want to be emailed by MSV when coded ui test failed. I tried SMPT format but I dont know how to write true code for it. I mean I can send an e mail myself but it doesnt depend on whether test is fail or not. How can…
Davut Kılıç
- 1
- 3
0
votes
2 answers
how should I document my application
We have developed an application in c# .net and aim to make it deployable within our intranet. We would like to have a solid documentation to go along with it but are unsure of the best platform to document this. Any tools available to facilitate…
user391986
- 29,536
- 39
- 126
- 205
0
votes
1 answer
Where to look to understand spring?
My real question is about how to look up the expectations on the methods (the 'contract' for a method) in Spring. I keep hitting questions, where unless I find some blogger or a stack-overflow that addresses that specific issue, there seems to be…
Matt S.
- 878
- 10
- 21
0
votes
1 answer
Why programming documentation has square brackets and commas in weird places?
Why in various programming documentation for functions do they have square brackets around parameters, but they are ordered such that the later parameters seem to be subsets of the first? Or if the brackets in that language delineate arrays it's as…
Brew Dain
- 131
- 1
- 3
0
votes
1 answer
doxygen: two makros in one description box
I want to connect two related define-makros in my doxygen HTML-documentation in such a way, that they are shown in a single description box.
I hope I can describe clearly how it should look like: Normally every define statement gets its own…
much
- 47
- 1
- 1
- 4
0
votes
1 answer
apidocjs not returning anything in response
I have installed 'apidoc' after installing 'npm' and 'node' for my API documentation by the help of following command:
npm install apidoc -g
After installing apidoc globally, I simply ran below command on my project directory (assuming apidoc will…
Shadman
- 755
- 2
- 11
- 19
0
votes
0 answers
SpriteWalkthrough (Apple doc) translated to Swift
In SpriteViewController
in Obj-C, by Apple:
- (void)viewDidLoad
{
[super viewDidLoad];
SKView *spriteView = (SKView *) self.view;
spriteView.showsDrawCount = YES;
spriteView.showsNodeCount = YES;
spriteView.showsFPS = YES;
}
in…
Fine Man
- 455
- 4
- 17
0
votes
1 answer
RStudio .rd-file - Binomial cofficient in Help file
I just got a minor problem which keeps bugging me:
I'm currently creating my own R package and obviously need some documentation/help files for that. I'm good so far, but I currently try to work out how to use the \choose command in .rd-files. It…
Loop
- 480
- 2
- 9
0
votes
1 answer
Does anyone know what, if any, doc generator was used for techbase.kde.org?
I was looking over some of the API reference pages for KDE and was specifically looking into their techcase docs and the more I navigate through the sub-pages of https://techbase.kde.org, the more I really enjoy their readability, lean, clean, etc.…
user118190
- 2,139
- 7
- 29
- 45
0
votes
1 answer
What type definitions does the Angular official reference documentation use?
In the official documentation, you often see types denoted like this:
!Array.= (e.g. here: https://docs.angularjs.org/api/ng/function/angular.module)
What does this mean? (especially the ! and = signs in my example)? Where is it explained?…
NicBright
- 7,289
- 5
- 18
- 19
0
votes
2 answers
Can different styles be read by Doxygen
Can Both Style of comments below be read by Doyxgen?
The Doxy Block Comments are in this format:
/**
* \brief
* \param
* \return
*/
and the ones in the libstdc++ are in this format:
/**
* @brief
* @param
* @return
*/
Zachary Kraus
- 1,051
- 10
- 21
0
votes
1 answer
Where are the groovy properties for jdk extensions documented?
The Groovy JDK docs, here http://groovy.codehaus.org/groovy-jdk/ don't seem to show the properties on the objects. I'm familiar with this site: http://groovy.codehaus.org/ which has some examples allowing folks to divine properties, but it at…
John LaBarge
- 149
- 1
- 9
0
votes
2 answers
Inline Documentation Comments for Objective-C Protocols and their Methods & Properties
Problem:
There Should be a Documentation Comment written for each Method in the example SCParserDelegate Protocol.
Context:
I'm Building a Parsing Framework to be used by 3rd Party Developers. (This is my first Framework project, so my development…
Jono Tho'ra
- 1,476
- 3
- 18
- 28
0
votes
1 answer
How to use comments or something else to split up code into sections
In my intro to programming courses, most things were split up into sections with comments, like this:
@interface ClassA : NSObject
{
@protected
NSMutableArray *_objects
}
/* constructors */
+(id) initWithObjects: (NSMutableArray *)…
michaelsnowden
- 6,031
- 2
- 38
- 83