Syntax specification in restructredText

In an documentation of some custom syntax I’d like to distinguish the literal part of the syntax from the placeholders (variables, non-terminals…): The syntax is P(audio-file) I currently use this in my restructuredText document (I am using...
more »

2017-10-16 02:10 (0) Answers

Build a structured document on GitHub

So I want to write a guide/tutorial/notes document (about Selenium, but this is beside the point for now). I want to do it in Markdown on GitHub to enable simple access and editing and cloning all that jazz. It will be open-source (CC-BY or something...
more »

2017-10-13 17:10 (0) Answers

YARD: Document non-useful or unintentional return

I have an impure function like so: # Impure function: Sets the status for a report_schedule, uses last_sent to # calculate status # @param report_schedule [Hash] # @return [String] Non-useful: value of last_sent that was set def self.set_report_sche...
more »

2017-10-13 10:10 (1) Answers

Where is "Auto Layout Help" topic?

I'm reading Autolayout guideline/documentation. And I often see info like: For more information, see Setting the Placeholder Intrinsic Size for a Custom View in Auto Layout Help. But I can't understand where this "Auto Layout Help" is? Also...
more »

2017-10-12 21:10 (1) Answers

Extract documentation from an r package

I'm trying to write an R function which will extract exported functions from an R package and return a list containing for each function, the call signature, and the description from documentation. Getting the list of exported functions can be done ...
more »

2017-10-12 15:10 (1) Answers

Grails Doc command Grails 2.30

I'm trying to generate a document using grails doc command but keeps throwing Error generating javadoc: No source files and no packages have been specified. Please advice ...
more »

2017-10-12 11:10 (0) Answers

How to generate Oracle Apex Documentation?

I know this topic is annoying but I need to generate a documentation for Oracle Apex at least database objects, I used JavaDoc for Java but I can't find anything regarding APEX. Someone have an idea? If I find something, I will share it. ...
more »

2017-10-11 23:10 (0) Answers

JDK 9 API documentation download

Is there a downloadable zip file of the Java 9 API documentation? It would be handy for offline coding. Java 8 documentation can be downloaded from - linke...
more »

2017-10-11 18:10 (2) Answers

R function parameter tooltip

Firstly, my apologies for some amateur questions: I am attempting to package R functions following Building R package and roxygen documentation The functions are visible to other projects with its documentation when querying with ?. However, I am h...
more »

2017-10-11 18:10 (0) Answers

find docs about internal keywords in clojure

I am a beginner. I found many keywords in many docs. I have tried search somewhere but it did not come with a solution, And i don't found how to use them. E.g. :allow :init Could you tell me where i can find docs about how to use all these keyword...
more »

2017-10-11 16:10 (1) Answers

Knockout documentation

Looking at I notice subscribe function and I would like to read about the parameters, possible values for those parameters and just a better understanding everything subscribe can do. Unfortunate...
more »

2017-10-10 18:10 (0) Answers

Multiple languages in doxygen docs (C++)

My client gave me unusual (and non-negotiable) requirement to provide them with dual-language (English and Polish) doxygen documentation from C++ code. My first idea is to use conditional compilation for comments, like: #if DOXYGEN_ENGLISH /** * @...
more »

2017-10-10 10:10 (1) Answers

Customizing simple documentation with pydoc / pdoc

I want a simple tool to create documentation for my module and pdoc is great, but I need a few minor customizations. In my module, there are many files which are treated as submodules by pdoc, but they are actually there just for my convenience (in...
more »

2017-10-10 10:10 (0) Answers

Multiline comment in rd files / vignettes

Is there a smart way for multiline or block comment in Rd files for R project, or vignettes? The code below sort of works, but it's not really convenient to comment vignettes including R chunks, e.g. each chunk has to be commented separately. ``...
more »

2017-10-09 17:10 (0) Answers

Use Sphinx to generate standalone html files

I'm quite new to Sphinx and I'm trying to create the docs for my application. It would be nice to generate a "standalone" html file for each topic. I mean: Sphinx creates a useful navigation panel on the left, with some modules (toc, next topic, sea...
more »

2017-10-08 18:10 (1) Answers

Escaping `/**` in asciidoc

My goal I am trying to submit a fix to the Filebeat documentation, written in asciidoc. Source Currently it is not possible to recursively fetch all files in all subdirectories of a directory. However, the /** pattern can be used to fetch a...
more »

2017-10-08 14:10 (1) Answers

Laravel REST API documentation generator

I use Laravel 5.1, in a few weeks will be on a 5.5.*. I currently use Swagger, but I am not longer satisfied with that solution (lack of documentation, harmful debugging and big doc blocks). Is there a better one available? I've heard about those: ...
more »

2017-10-07 14:10 (0) Answers

How do you document return example using JSDoc?

@example tag is designated for usage example, however is there a specific tag for documenting example output? For example like: /** * Fetch user record from server. * @param {number} id The user identifier. * @returns {Promise.<Object>} An...
more »

2017-10-05 00:10 (0) Answers

jobs and workers Golang

Who can explain me what is the jobs and what is the workers in golang, I have read the doc in Go By Example but can not understood . thank you in advance ...
more »

2017-10-04 17:10 (0) Answers

Documenting exported object methods using JSDoc

I have a module that consists of a constructor function that exports an object. The object's methods are populated by functions within the module: /** module createExample **/ /** * Alpha docs. */ const alpha = () => {} /** * Bravo docs. */...
more »

2017-10-04 16:10 (0) Answers