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
0
votes
1 answer

How to get simplified ReturnType through MethodInfo?

Using reflection to obtain a MethodInfo, I want to get a more user-friendly version of the ReturnType for some self-documentation. Currently this methodInfo.ReturnType.Name returns something like Dictionary2 or IEnumerable1. While this…
Ganon
  • 65
  • 8
0
votes
1 answer

Javascript import: "no bare module allowed"?

I was reading this article about Javascript module: https://javascript.info/modules-intro#no-bare-modules-allowed It says In the browser, import must get either a relative or absolute URL. Modules without any path are called “bare” modules. Such…
shenkwen
  • 3,536
  • 5
  • 45
  • 85
0
votes
1 answer

Is this documentation missing anything?

I've written this documentation of a rather simple class, but I feel it's not clear enough. Should I change anything? /** Pointer class that wraps resources loaded through the ResourceManager. The manager is notified to increase or decrease…
Paul Manta
  • 30,618
  • 31
  • 128
  • 208
0
votes
0 answers

JSDoc in external file, possible? How?

I think it looks messy and harder to read when JSDoc is mixed into regular (JS) code. Is it possible to add the documentation to an external file & reference the functions there (and have Visual Studio's "preview" of parameter types & return values…
Sebastian Norr
  • 7,686
  • 2
  • 12
  • 17
0
votes
0 answers

Understanding MDN documentation for array filter

I understand how array filter works and that the filter helper function takes a callback function that takes one mandatory argument (element) and two optional ones (index, array). However, it's confusing to understand this based on how the MDN…
Lightspeed1212
  • 11
  • 2
0
votes
1 answer

Proper static usage with BorderLayout

Documentation I have read for BorderLayout claim that is is best to use PAGE_END, PAGE_START, LINE_START, LINE_END, and CENTER. (https://docs.oracle.com/javase/tutorial/uiswing/layout/border.html) However, I have also found documentation that uses…
Parzavil
  • 388
  • 3
  • 13
0
votes
1 answer

How to securely send basket order and payment information to PayPal in PHP?

I've been looking through the following PayPal guide (as it's the only available document I could find that details PHP implementation AND can handle basket/cart/multiple…
Denver Thomas
  • 114
  • 9
0
votes
1 answer

Where is the Android Notepad sample?

https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase says See the Notepad sample application in the SDK for an example of creating and managing a database The page provides no link. However if I use the Search facility…
prepbgg
  • 3,564
  • 10
  • 39
  • 51
0
votes
1 answer

How to read the documentation syntaxes?

Can someone explain how I read this syntaxes like the one below. In which I'm picking the MDN reduce method reference. I want to know what the brackets mean, why there's a comma before the words and etc. arr.reduce(callback( accumulator,…
innis
  • 370
  • 1
  • 3
  • 14
0
votes
0 answers

Typescript command line options reference

Is there a reference for all the TypeScript command line options? I've searched everywhere and can't seem to find any resource that is dedicated to documenting all those options; not even in the official Typescript Lang documentation site.
prmph
  • 7,616
  • 11
  • 37
  • 46
0
votes
2 answers

In moment.js where to find methods that mutate date

Moment.js mentions that the data is mutable here and therefore if you say: var a = moment('2016-01-01'); var b = a.add(1, 'week'); a.format(); "2016-01-08T00:00:00-06:00" The data in a changed when naively changing b without the use of .clone()…
Kevin Crum
  • 195
  • 2
  • 16
0
votes
0 answers

Generate documentation of existing Cordova project?

I've started working on an existing Cordova project, and I'm unfamiliar with both the codebase and the development framework. The project is not externally documented, which makes learning the codebase more difficult. I'm aware that there are…
Galen
  • 1,128
  • 1
  • 14
  • 31
0
votes
0 answers

Python Documentation that List all Parent and Child Class

I'm a Java programmer who is working with Python. So I'm using the Typing support to increase code readability. But I'm having a hard time with types (returning types of methods, and parents), and the documentation isn't helping in that way. Right…
vinicius de novaes
  • 389
  • 5
  • 15
0
votes
0 answers

Adding tax rates on InvoiceIntem

Environment : NodeJS Language : Typescript I am trying to add Tax Rates to my InvoiceItems, but it seems that the Stripe package does not follow the API doc. Here is my code : newInvoiceItem = await this.stripe.invoiceItems.create({ …
Ninjeneer
  • 76
  • 2
  • 6
0
votes
1 answer

Android studio: add comments to read-only files

I need to add some comments in a read-only file opened by Android Studio, for personal documentation purposes. Obviously, I can't use normal comments. Do you know if the editor have some functionality to do this?
Lore
  • 1,286
  • 1
  • 22
  • 57
1 2 3
…
25 26