Stack Overflow
Stack Overflow

Questions tagged [code-documentation]

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.

381 questions
1
vote
3 answers

Documenting exceptions

I have the following public interface public interface Bar{ public void DoStuff(); } with an internal back end class internal class BarImpl : Bar{ public void DoStuff(){ // throw exception if invalid state // do something …
GETah
  • 20,922
  • 7
  • 61
  • 103
1
vote
1 answer

Automatically replace the PlantUML code in an .adoc file with the corresponding PNG images

I have a big .adoc file with plantUML Diagrams in it. The main goal is to convert the .adoc from asciidoc to markdown. For that it is necessary to replace the .puml diagrams to images (png). Its possible to extract the .PNGs from a .adoc file, but…
emotionalDamage
  • 53
  • 6
1
vote
1 answer

C# Documentation: refer to other property

Suppose I have this class public sealed class Person { public string FirstName { get; set; } public string LastName { get; set; } public string DisplayName => $"{FirstName} {LastName}"; } And I want to document the DisplayName property. ///…
Wouter Vandenputte
  • 406
  • 4
  • 12
1
vote
1 answer

Documenting APIs - /me endpoints

I have a portfolio where I display my work (mostly backend API stuff with minimal UI to interact with) and am currently documenting the APIs. What I have is a page per project along with the documentation that belongs to it. In my APIs, I use a…
Tom687
  • 182
  • 2
  • 14
1
vote
0 answers

Vs Code does not show flutter quick documentations while typing code

When I started with it, I used to get these quick docs where it would for example explain what the class would do or show the different color shades alongwith their numbers but now it doesnt and Ive tried every solution on the internet but got no…
Syed Abdullah
  • 112
  • 9
1
vote
1 answer

Using PostgreSQL comments as descriptions in dbt docs

We've been adding comments to the columns in postgres as column descriptions. Similarly, there are descriptions in dbt that can be written. How would I go about writing SQL to automatically setting the same descriptions in postgres into dbt docs?
Mark
  • 105
  • 1
  • 5
1
vote
0 answers

R Roxygen2 documentation without building a package

I am currently programming within an R project. Right now there is no need for building a whole package, but I would like to use roxygen to create documentation of several functions nonetheless. Whenever I am looking for "object documentation" or…
KidLu
  • 163
  • 8
1
vote
1 answer

How to test if all functions in my project are commented with

I'm using jetbrains-rider / C#. I want to test and find out if all my functions are fully commented like /// /// Add a and b /// /// a int /// another int …
K--
  • 659
  • 1
  • 7
  • 18
1
vote
2 answers

Canon ccapi contents` returns 100 images only

I am using Canon ccapi to download the last image taken. I am trying to find it by getting the list of all the photos from contents request and then download the last one http://:8080/ccapi/ver100/contents/sd/100CANON but actually it…
Serob_b
  • 965
  • 12
  • 29
1
vote
1 answer

What have they used to write their API documentation?

I was wondering what application/service have those guys used to write their documentation? I'm especially interested in that playground section in the right side. https://docs.nftport.xyz/docs/nftport/b3A6MjE0MDYzNzY-upload-a-file-to-ipfs
Terchila Marian
  • 2,225
  • 3
  • 25
  • 48
1
vote
0 answers

sphinx documentation not getting docstrings/modules

Hej! :) I want to create a documentation of my django project and using sphinx. I wrote docstring to every function and class which I want to be integrated automatically. I followed this tutorial and everything run. My documentation won't give me…
piah
  • 95
  • 1
  • 12
1
vote
1 answer

Documentation for Firebase Remote Config *Client* API?

I'm looking for documentation detailing the API that allows clients to connect to Firebase Remote Config. I'm making a Unity project for a platform other than mobile, and I've built my own client code for other Firebase products since no client…
yummypasta
  • 1,398
  • 2
  • 17
  • 36
1
vote
0 answers

Shell help text syntax for repeatable group of arguments

I'm writing a help output for a Bash script. Currently it looks like this: dl [m|r]… (| [m|r|]…)… The meaning that I'm trying to convey (and elsewhere describe with words) is that (after a potential "m" and/or "r") there can be an…
Fabian Röling
  • 1,227
  • 1
  • 10
  • 28
1
vote
0 answers

Javascript documentation is vague in VS Code, is there a plugin to show more?

Excuse my naïvety, but I find Flutter/Dart documentation very intuitive and easy to use in VS Code. Same goes for Android Studio when I was using it. Now using VS Code for javascript and Parse Cloud code there is almost zero documentation. Am I…
RobbB
  • 1,214
  • 11
  • 39
1
vote
1 answer

Mixing code documentation with code by appending various notes to sections?

Consider the following minimal example: docs/index.rst * :ref:`modindex` docs/modules.rst exampleproject ============== .. toctree:: :maxdepth: 4 exampleproject .. print_notes_attached_to_topic:: :topic:…
d33tah
  • 10,999
  • 13
  • 68
  • 158
1 2 3
…
25 26