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
4
votes
0 answers

Documenting Kotlin code: How to create a table?

I have read this article about documenting Kotlin code and this article as well. I tried this code: /** * | First Header | Second Header | * | ------------- | ------------- | * | Content Cell | Content Cell | * | Content Cell | Content Cell…
Anggrayudi H
  • 14,977
  • 11
  • 54
  • 87
4
votes
3 answers

How to refer to "True-like" and "False-like" when documenting a function?

Strongly related question. When writing docstrings for my functions in python, I sometimes want to write something like this about argument specifications: def foo(bar): """ Do some stuff. bar : callable must return True if XXX…
Alexis
  • 337
  • 1
  • 12
4
votes
1 answer

How to document an enum case with parameters?

Given an enum that has a case with parameters, how can I document these parameters? For example these code comments: /// Various coffee types. enum Coffee { /// A Cappuccino. /// - parameters: /// - cream: Is true if cream is added. case…
Manuel
  • 14,274
  • 6
  • 57
  • 130
4
votes
1 answer

Trying to manage Raku's $*REPO at runtime

Duplicating the behavior of FindBin::libs in Perl 6. (1) Start from `$Bin`. (2) Search for `./lib` dir's above it. (3) prefix them to the search list. In Raku, this requires managing $*REPO, which I think requires using…
Steven Lembark
  • 99
  • 2
4
votes
1 answer

How to properly document properties with NumpyDoc

I'm managing a package which uses the NumpyDoc style, and I'm trying to properly document the setters/getters of some properties. In particular, I'm having an issue with the fact that the documentation of the setter is ignored by python, and hence…
Jonas Adler
  • 10,365
  • 5
  • 46
  • 73
4
votes
1 answer

Referencing documentation comments (or parts thereof) in other classes/methods/fields

Is it possible to tell Visual Studio to use the whole or part of the documentation comment of another class/field/method for the given class/field/method? It would be nice if in the following scenario, public class Foo { /// ///…
Kjara
  • 2,504
  • 15
  • 42
4
votes
2 answers

How to inline code document Swift sources with Xcode 6

I've been using the Xcode 5's ability to document my code with the supported comment syntax (see this SO question). Xcode 6 supports it with Objective-C sources, unfortunately not with Swift sources. I would like to perform inline documentation on…
Luis Palacios
  • 396
  • 1
  • 3
  • 14
4
votes
0 answers

Widely accepted methods for documenting PHP source code in an auto-doc way?

Possible Duplicate: Automatic PHP Documentation Generation? I'm new to PHP, and my current job requires me to pick up the language at an extremely quick pace. I'm a documentation stickler. I even like to write documentation. I'm familiar with…
jeremyosborne
  • 1,072
  • 1
  • 10
  • 17
4
votes
3 answers

ColdFusion, and documenting code as well as tools for multiple developer teams

I am beginning a fairly large new project using ColdFusion. This new project will include several developers and as such documentation of code will be key. Another issue I am hoping to avoid (either with adequate code documentation or some other…
cra
  • 127
  • 1
  • 9
4
votes
2 answers

How to describe function arguments in dynamic typed languages?

My question is more oriented toward Python, but it may also be about JavaScript or other scripting languages. I usually develop with statically typed languages (Java, C++, ActionScript, ...). I like to use from time to time Python, and I also need…
Vincent Hiribarren
  • 5,254
  • 2
  • 41
  • 65
3
votes
2 answers

Code documentation editor

I've been looking for a code documentation editor app. I don't mean just a generation tool like doxygen, but an application that allows me to edit the documentations and change it directly at the code. Does anyone out there know of a good…
TCS
  • 5,790
  • 5
  • 54
  • 86
3
votes
1 answer

webview_flutter migration V4 Doc

How do I make my current code compatible with V4 update I checked their documentation but I couldn't follow along final Completer _controller = Completer(); WebView.platform = SurfaceAndroidWebView(); WebView( …
zakiblacki
  • 187
  • 1
  • 10
3
votes
0 answers

Documenting a Side Effect in a Function Using reST Style Docstrings

I've been using reST style docstrings for a while, but I was browsing through the sphinx docs again to refresh my memory and realized that I'm not quite sure if there's a "standardized" way to document the side effects of a function. For instance,…
Pacopenguin
  • 194
  • 1
  • 9
3
votes
3 answers

Docstrings Python Function when parameters are package objects like Pandas DataFrame

i want to know how documentation a python function when one of parameters is a object of package for example a pandas DataFrame. i use this method but PyCharm(python IDE) doesn't understand it. def foo(df , no ,…
alish
  • 149
  • 2
  • 11
3
votes
0 answers

Any way to get kotlin docs working with Intellij?

I wonder is there any way to get kotlin docs working like java ones(javadocs) with Intellij? I was trying to look for a way but so far haven't found one. For java we can specify local docs or even web docs and use them under our keyboard shortcut…
RMachnik
  • 3,598
  • 1
  • 34
  • 51
1 2 3
…
25 26