Writing Technical Design Documentation

I have designed a web app and I want to write a technical documentation for it. What are things I should include in my documentation such that it can make someone who has not been involved in the project understand the parts and subparts of project ...
more »

2017-06-20 06:06 (0) Answers

Guidelines for Google Code Prettify

I'm hoping to pick up Issue 295 from Google's Code-Prettify project; i.e. to add support for lang-powershell. Whilst I've found some code examples, I can't find any documentation on how this code should be written, or any submission guidelines (e.g....
more »

2017-06-19 15:06 (1) Answers

extract standard library to methods file

I need to create autocomplete file for custom made editor written in other languages. With the keywords it is simply: >>> import keyword >>> s = " ".join(keyword.kwlist) But I don't know if there is something similar. If not doe...
more »

2017-06-18 13:06 (2) Answers

Explain API function signature syntax

Reading documentation for a few years I've often been confused by the syntax commonly used in explaining function signatures. for instance: From the Mozilla Array.map Docs: var new_array = arr.map(callback[, thisArg]) The docs list three argument...
more »

2017-06-17 14:06 (2) Answers

Create documentation for an R project

I would like to create documentation for my R code. The code is a part of an R project but not of a package. Is there a way I can display documentation for code not in a package using the built-in help viewer without creating a full package? ...
more »

2017-06-15 14:06 (1) Answers

Add images to documentation in Matlab

I'm writing some classes for a matlab package that I'm writing. There's a way to insert image links into the class documentation, so when I press F1 and I see it, images appear? I'd like to create a documentation like: classdef MyClass < MyBase...
more »

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

Software for local list and attachments?

someone knows about a piece of software (open-source or not) in which you can make a list of people and attach documents (docs, images and pdf) to each one of them all this in local storage ? A client needs something like that but making it from 0 wo...
more »

2017-06-13 01:06 (0) Answers

Javascript file documentation style

As a newcomer to JS and JS linting, please pardon me if my question is silly. The Pythonic convention for file-level documentation is a docstring at the top of the file, just below the shebang: #!/usr/bin/env python """This module converts meters ...
more »

2017-06-12 13:06 (1) Answers

How to open PDF in ionic 2

Trying to open a pdf in ionic 2, when using the documentation method getting the error type of enter image description here, on using the code<button onclick="window.open('http://www.orimi.com/pdf-test.pdf', '_system', 'location=yes'); return fals...
more »

2017-06-06 08:06 (0) Answers

where to specify documented files in Breathe?

Problem: sphinx output is default index page, no documentation was grabbed from doxygen output. The doxygen output contains all of the specified documentation. I've documented a file for a test, and then wanted to try setting up Sphinx documentation...
more »

2017-06-05 18:06 (0) Answers

Xcode inline markup documentation syntax for tags

There a great write up here for markup tags that is unfortunately out of date now. Other similar posts, such as this one, are also out of date. The following tags are examples. @param: With this you can describe a parameter of a method or functio...
more »

2017-06-05 15:06 (1) Answers