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

Diagrams Net (Draw IO) Link to open local file

I have a project documentation written in ASCIIDOC with editable PNGs and I would like to create a link in my documentation that opens a local file directly in draw.io (diagrams.net). Something like…
sashok_bg
  • 2,436
  • 1
  • 22
  • 33
7
votes
0 answers

doxygen: include documentation of convenience alias in a section under class documentation

I have defined the following type traits struct with the associated documentation: /*! * @brief Get the type at a given index Idx from a template parameter pack TPack. * * Provides a member type holding the type at a given index Idx in a…
Davide
  • 387
  • 2
  • 11
7
votes
2 answers

What is the availability of NSNotFound?

This in-Xcode documentation for NSNotFound is quite confusing: It says "Available in iOS 2.0 through 8.4" and "Availability: iOS 8.1 to 8.0". So... Is it available before 8.0? Or in 9.0+? Also, what's going on here, if it is?
Ky -
  • 30,724
  • 51
  • 192
  • 308
7
votes
2 answers

Julia API / Documentation Generation

Does Julia have any built in tools for documentation generation from source? Something like doxygen? I couldn't find anything natively supported and am curious if something does in fact exist or if someone can recommend an external application.
Mageek
  • 4,691
  • 3
  • 26
  • 42
7
votes
2 answers

Google Apps Script Auto Generated Library Documentation

I am currently developing a Library for Google Apps Script that basically treats a spreadsheet as a database object. Currently, the library has a two identical functions like /** * Opens and creates a query object for a spreadsheet with the given…
frostymarvelous
  • 2,786
  • 32
  • 43
6
votes
0 answers

How to YARD-document return type of method with yield?

I would like to better document the return type of this naïve memoization method using YARD: # Ensures that given block is only executed exactly once and on subsequent # calls returns result from first execution. Useful for memoizing methods. # #…
Nicolas
  • 472
  • 6
  • 14
6
votes
1 answer

How do you correctly document Powershell functions?

I'm new to Powershell and as best as I can find it doesn't have anything like PEP8/PEP484 in Python. I found this document from Microsoft and this third party guide from Posh Code. I have written the following function: function Invoke-Authenticate…
Grant Curell
  • 1,321
  • 2
  • 16
  • 32
6
votes
1 answer

How to customize Compodoc Angular documentation?

I have tried to add additional side nav menus with existing compodoc documentation. I could do that like below. menu-wc.js
  • Cegone
    • 489
    • 1
    • 9
    • 23
    • 6
    votes
    1 answer

    what does angle brackets mean in documentation?

    little did i know. that square brackets [option] are used to indicate a parameter that is optional. such as function(param1 [, param2]) which indicate that param1 is required and param2 is optional. but what about angle brackets and --…
    Ghani
    • 81
    • 7
    6
    votes
    1 answer

    Kotlin Dokka - Can't find Dokka task in android studio

    I am new to Kotlin and Dokka; Following wikis and tutorials I've tried to setup my project for dokka documentation tool with the following lines in gradle build files: In project gradle file: classpath…
    Ettore Galli
    • 677
    • 6
    • 24
    6
    votes
    2 answers

    Groovydoc: Documenting named parameters

    I've created a method like so: void myMethod(Map kwArgs, def myParam) { println kwArgs.firstName println [kwArgs.lastName, "Wilcox"].find() // ^^^ if lastName named parameter not specified, "Wilcox" .... } Now comes the time to…
    RyanWilcox
    • 13,890
    • 1
    • 36
    • 60
    6
    votes
    1 answer

    Automagically adding yard doc skeletons to existing Rails legacy code

    I would like be able to insert templated YARD doc style comments into my existing Rails legacy application. At present it has few comments. I would like class headers and method headers that have the params specified (by extraction from the method…
    TJChambers
    • 1,489
    • 1
    • 18
    • 28
    6
    votes
    0 answers

    Documentation about compiler options for Swift

    Hello, i want to start running some microbenchmarks on Apples Swift-language. However i feel it is hard to find proper documentation for the different options in regards of compiler optimization. I have read a lot of questions and articles about…
    Christian Martin Henriksen
    • 109
    • 6
    6
    votes
    4 answers

    Selectively suppress XML Code Comments in C#?

    We deliver a number of assemblies to external customers, but not all of the public APIs are officially supported. For example, due to less than optimal design choices sometimes a type must be publicly exposed from an assembly for the rest of our…
    Mike Post
    • 6,355
    • 3
    • 38
    • 48
    6
    votes
    3 answers

    Code documentation in QTP / UFT

    I am looking into ways of documenting my code in a JavaDocs kinda way. Any ideas? I use UFT 11.52 So far I have seen NaturalDocs + Perl. Any other ideas? Thanks in advance.
    Pixie
    • 412
    • 1
    • 8
    • 26
    1 2 3
    …
    25 26