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
1 answer
Documentation for C# Project Property: `strict `
I want to develop C# with all possible warnings from Microsoft turned on, and I found this answer that says to add strict to my .csproj file.
However, before I start using it, I want to read up on what warnings it enables and…
Floating Sunfish
- 4,920
- 5
- 29
- 48
0
votes
0 answers
Python imaplib documentation
I'm looking into the python imaplib library and starting testing things. I looked in the documentation and
read that get_payload() is deprecated and you have to use get_body().
When I look at my object with dir() I have get_payload() but not…
Deus
- 39
- 1
- 6
0
votes
0 answers
How to add documentation to cloned R repository
I am currently working on a private data repository on GitHub, but keep running into an issue with the documentation that comes up when searching ??myRepository.
I have a folder called man in my data repository that stores all the .Rd files that…
starbuckslychee
- 1
- 1
0
votes
1 answer
What is the convention for documenting variables with setters and getters in Dart?
Consider the following example (common if you use the provider Flutter package): You have a class with a private variable that can be accessed via a setter and a getter. What is the convention / recommended way to document this?
class Foo extends…
Hannes Hultergård
- 1,157
- 1
- 11
- 33
0
votes
1 answer
Doyxgen onetime macro expansion / expansion command
I have some code like the following example:
/** @file HelloPi.c */
/** The definition of pi */
#define PI 3.1415
/** @brief The main function.
* @details Prints the value of #PI, which is actual defined as 3.1415. */
void main()
{
printf("The…
Jan
- 7
- 2
0
votes
2 answers
How to document a parameter that appears in more than function in Python?
Suppose that I have three functions a, b, and c. The way a is defined and documented is like this:
def a(a1, a2, p1="a", p2="b", p3=3):
"""
:param a1:
:param a2:
:param p1: blah
:param p2: blah blah
:param p3: blah blah blah
"""
Now,…
Diamond
- 598
- 5
- 15
0
votes
1 answer
Can I employ back-ticks and parentheses with doxygen @ref?
I want a doxygen comment in my C++ code to refer to a certain function; say, in a different namespace: foo::bar(). And let's ignore the possibility that this function is overloaded. And I would also like the function's name to be set the same way…
einpoklum
- 118,144
- 57
- 340
- 684
0
votes
1 answer
What does the [‸D] symbol mean in this context?
On the documentation page for the tcsh complete command, it lists the symbols [‸D] and [‸C] several times. I haven't found anything from Google. Context suggests that they could be single or double tab, but I can find no reference to support this…
Lou
- 2,200
- 2
- 33
- 66
0
votes
1 answer
R: Finding help for classes created by packages
It often seems to be the case that R packages contain multiple functions that create an object of some class, specified by the package, with generic or non-generic methods that apply to all objects of that class. Although it is generally easy to…
andrewH
- 2,281
- 2
- 22
- 32
0
votes
1 answer
Where are the definitions for methods in nativescript docs
This is a (hopefully) rather simple question. In the nativescript documentation, the method definitions always say something like "Defined in ui/core/view-base/view-base.d.ts:301", but I have no clue what that's referring to and I need to know what…
Felix
- 37
- 1
- 5
0
votes
1 answer
What is the usage of blacklist.txt in pythonforandroid (p4a)?
In the documentation of pythonforandroid, at https://python-for-android.readthedocs.io/en/latest/buildoptions/, there is a build option described called blacklist.
--blacklist: The path to a file containing blacklisted patterns that will be…
BLUC
- 2,590
- 2
- 15
- 24
0
votes
0 answers
What is the best practice with regards to type consistency for returning a result, error, or warning in Python?
This might be answered elsewhere, but I had trouble finding a good "Googlable" phrasing to this question. I have a Python program I'm writing where the lead has requested that all exits from the program occur in the main body - which makes sense.…
Grant Curell
- 1,321
- 2
- 16
- 32
0
votes
1 answer
skip_unchanged and report_skipped in django import-export
The django import-export documentation says
report_skipped= True
Controls if the result reports skipped rows Default value is True
skip_unchanged= False
Controls if the import should skip unchanged records. Default value is False
I Don't quite…
Saravanan
- 566
- 5
- 13
0
votes
1 answer
PHP documentation on method
I'm writing some documentation on my PHP files and I am not sure what type the $description variable should be in this scenario.
My guess is that it would look something like this but I am really unsure.
/**
* Undocumented variable
*
* @method…
Zelcus
- 30
- 6
0
votes
2 answers
Issue "Could not render n, see the console" in Swagger with Laravel 5.8
In laravel 5.8 my swagger documentation is displaying fine but when I enter execute then its coming with 'Could not render n, see the console.' error.
composer.php
"darkaonline/l5-swagger": "5.8.*"
what can be the reason? anyone please suggest.…
Md imran
- 57
- 1
- 2
- 9