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

Android documentation differs from Android Studio warning

I'm currently implementing an AlertDialog in which there is a CheckBox. In order to do that, I inflate a view containing a CheckBox and then I add it to my Dialog using the setView(View) method, but by proceeding that way I get huge padding. From…
0
votes
0 answers

Function Definitions Size does not fit on xcode

Possibly a dumb question, however, I would love to know if there is a way in Xcode9 to expand the function definitions. As shown below, most of the text does not fit properly (unable to read) even when both Navigator and Utilities Bars are closed…
heavyguidence
  • 363
  • 1
  • 8
  • 23
0
votes
1 answer

Getting list view results from jsforce

I'm able to get the results of a list view like so: conn.sobject('ListView').retrieve(listId, function(err, listView) { console(listView); }); But that only returns the description of the list view without the results and I want to get the…
snn
  • 405
  • 5
  • 15
0
votes
0 answers

How to capture personal or organizational programming best practices?

...or, what is the best practice for capturing best practices? Note that I am not asking what these best practices are; these will vary from person to person, team to team, language to language, domain to domain. To clarify, I am curious if there is…
Dan
  • 802
  • 6
  • 22
0
votes
0 answers

AirPlay Receiver documentation

I am trying to find resources about Airplay for Windows, to be exact Windows Host acting as a receiver. There are multiple applications out there. Just to name some: reflector 3, AirServer. I am wondering which language this is and on what reference…
0x45
  • 779
  • 3
  • 7
  • 26
0
votes
1 answer

Where can I find API reference (JavaDoc) for alexa skills kit sdk2.0 for Java

I am sure its available somewhere, I have been searching from past few days now. All I get is git repository that has samples. https://github.com/alexa/alexa-skills-kit-sdk-for-java
0
votes
0 answers

Multiple documentation comments for one function JS

So I want to create a function as follows: Using various amount of arguments /** * Stuff with one argument. * @method foo * @param {type} a One argument. */ /** * Stuff with more arguments. * @method foo * @param {type} a1 Argument one. *…
0
votes
1 answer

Automatic INLINE Document Generation

First off, I'm not asking about how to generate documentation FROM PHP source. That's easy enough with libraries like Doxygen or PHPDocumentor. What I'm looking for is a way to automatically generate inline phpdoc-based comment stubs for classes,…
Wilhelm Murdoch
  • 1,806
  • 1
  • 22
  • 42
0
votes
1 answer

Printout many Matlab Code files at once

I have a folder with many .m files (about 150) and I need to print them out on paper. I do not want to perform this manually, as this is very tedious. Is there any way to make Matlab to the work?
ds_col
  • 129
  • 10
0
votes
2 answers

Polymer Web Components Documentation

Where can I find the documentation for web components managed by PolymerElements? I'm here: https://www.webcomponents.org/element/PolymerElements/paper-dialog, and the page says to see the Docs, but doesn't provide a link. I just want to know what…
user3689186
  • 148
  • 10
0
votes
0 answers

Problems with Doxygen and doxypi documenting Python code

I'm using Doxygen 1.8.11 to document a large base of Python code. I'm using it because I wanted the LaTeX documentation support (in addition to .html). Originally, I documented my code following the Doxygen recommendations, meaning without…
0
votes
1 answer

What does ${plugin::command} mean in NSIS?

I'm trying to figure out how to modify an XML file with NSIS. So I'm trying to learn how to use the XML plugin. The examples on the forum page often use the format ${plugin::command} like: ${xml::LoadFile} The documentation gives no indication that…
Kyle Delaney
  • 11,616
  • 6
  • 39
  • 66
0
votes
2 answers

C# to Require XML Documentation for internal members

Visual Studio has a nice feature to spit out a bunch of compiler warnings if some of the public members are missing XML documentation. I would love to have the same for internal, or better, any non-private members, but unfortunately so far I wasn't…
0
votes
1 answer

Understanding android documentation: handling runtime fragments "should never pass an object tied to the activity"

I'm relatively new to programming and I am having troubles with an orientation change. I would be thankful for any thoughts. This is a specific question about the official android documentation, please do not report this question as a duplicate and…
0
votes
0 answers

Usage of @since and @version in private method documentation

I'm reading up about when it is necessary to provide @since and @version in the documentation of Java classes, however when is it appropriate to provide them? Was their original purpose for all visibility types or only public and/or protected? I…
user5549921