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
Need to write a script working under Win32 to put the tags in place for documentation automatically C++/C#
We are managing a C++/C# library and we noticed that many classes and functions were left undocumented.
We thought about writing a script which would parse the code to look for undocumented classes and method to produce a list of undocumented…
BlueTrin
- 9,610
- 12
- 49
- 78
0
votes
1 answer
Why is edoc unable to discover callbacks?
For some time we are able to declare behaviour callback using -callback attribute instead of behaviour_info/1 (which in my opinion is more convenient). But, the edoc application seems to be unable to discover such attribute. Still, release notes…
Radosław Łazarz
- 950
- 1
- 11
- 25
0
votes
0 answers
Documenting processes in java code in Eclipse
In my java apps, I always comment my classes and methods to indicate what they are all about. The problem I often have however is documenting a complete process whereby the process is spread over several classes. I need to document how all the…
Johann
- 27,536
- 39
- 165
- 279
0
votes
1 answer
What are examples of comments that tell you WHY instead of HOW or WHAT?
First of all, in this question I'd like to stay away from the polemic on whether source code commenting is good or bad. I'm just trying to understand more clearly what people mean when they talk about comments that tell you WHY, WHAT or HOW.
We…
rick
- 1,626
- 11
- 18
0
votes
1 answer
SUSv4 like C code documentation
I'm writing a C library (on Eclipse) and I would like to generate documentation pages.
I really like the SUSv4's HTML documentation, can anyone please recommend me on a tool with a similar output?
Note: Auto documentation generation and Eclipse…
Tal A.
- 397
- 1
- 2
- 15
0
votes
2 answers
Which tool to use for C/C++ documentation?
Which tool is better for documentation of C,C++ and Java code out of 'Docbook' or 'doxygen' or any Can you please tell me any other tool?
sv1
- 57
- 1
- 2
- 11
0
votes
1 answer
Source Code via "Hyperlink" for Documentation
I'm becoming more insistent on documenting all of my code and demonstrating to users and other Engineers on my team where I am locating given information, or where I found a specific section of code.
What I would like to be able to accomplish is to…
signus
- 1,118
- 14
- 43
-1
votes
1 answer
Where to find the documentation for frappe on the github repo?
I'm on the frappe github repo and I need to find the folder that contains the documentation to contribute to it. A link to it would be super helpful .
Preshh0
- 19
- 2
-1
votes
1 answer
My Masters thesis topic is "Survival of undocumented code in & how to maintain it"
I have to submit my research proposal and I am very confused from where to start writing my proposal. Which type of methodology should i use in the Research Methodology section. And is there any solution to maintain undocumented code?
Maham
- 91
- 1
- 12
-1
votes
1 answer
Poor documentation for WayPoints
The documentation for waypoints is not matching the actual allowed API calls. It can be found at https://developer.here.com/documentation/routing/topics/resource-param-type-waypoint.html
Specifically, from this you should be able to use…
Tom Saul
- 19
- 4
-1
votes
1 answer
Practical tips on documenting Excel Queries, data model tables, pivot tables?
Building a BI system (dashboards) in Excel using imported tables (from excel files). We're using Excel 2016 query, data model, measures using DAX expressions, resulting in more pivot tables (some of which are reloaded into data model), etc.
My…
JMKõ
- 61
- 1
- 8
-1
votes
1 answer
How to javadoc a constructor extending an abstract class
I'm trying to document my Java code in the cleanest way possible, without having to copy stuff multiple times. Here is an example of what I've got, then I'll explain what I want:
public abstract class Toto {
/**
* Defined…
Puech clément
- 11
- 1
- 4
-1
votes
1 answer
What framework has been used to build scikit-learn's website
scikit-learn is a very well organized website and is a neat way to document source code. Are the webpages automatically-generated? Is there a framework which produces these pages?
Learning which framework has been used can help me document other…
Shash
- 83
- 7
-1
votes
1 answer
C++ code documenting: doxygen vs built into vc++ compiler
Does anyone use built into VC help generating system (/Doc - compiler option) .
Adv/dis in a comparing with Doxygen (excluding platform specific)?
Similar option in C# compiler can raise a warnings in case of undocumented items found in the code.…
amigo421
- 2,429
- 4
- 26
- 55
-1
votes
1 answer
Parsing a php script for documentation purposes
I've not been able to find any inexpensive tools to document all the vars/consts/functs/classes/includes in a PHP script, so I'm writing my own. (I use a lot of open source scripts that need to be modified. Plus, it would be nice to have a directory…
birchy
- 509
- 7
- 16