Top "Documentation" questions

THIS TAG IS FOR DOCUMENT GENERATORS ONLY.

Descriptions of error codes returned by regsvr32

Where can I find documentation that describes the meaning of error codes returned by regsvr32, such as 0x80070716?

documentation error-code regsvr32
How to document websocket events or callback in swagger

I have a setup where it is possible to get some resource using standard REST and this is easy documented …

api websocket documentation swagger
How do I document a constructor for a class using Python dataclasses?

I have some existing Python 3.6 code that I'd like to move to Python 3.7 dataclasses. I have __init__ methods with nice …

python documentation python-3.7 docstring python-dataclasses
Where is the documentation of Selenium Webdriver for NodeJS?

I don't seem to find any, the only one I always find is this one: https://code.google.com/p/…

node.js selenium selenium-webdriver documentation code-documentation
How can I configure Sphinx to conditionally exclude some pages?

When generating documentation using Sphinx, I would like to be able to generate two versions of my documentation: one including …

python documentation python-sphinx
Application (Not a Markup Language) for Producing a User Manual

Can anyone recommend a program to create user manuals with? Not a markup language (like LaTeX or DocBook) but more …

pdf documentation publishing manuals
_Best Practices for JSDoc'ing Javascript files written in the "revealing module pattern" Style?

Most of my Javascript functions are relatively simple, and called for their sideeffects: I use jQuery to manipulate the DOM …

javascript eclipse documentation documentation-generation jsdoc
Are docstrings for internal functions (python) necessary?

In python we designate internal function/ private methonds with an underscore at the beginning. Should these functions be documented with …

python documentation standards pep8
Writing Maintainable Event-Driven Code

I have just recently started playing with event-driven architectures, coming from a pretty standard object-oriented mindset. The first thing I …

architecture documentation node.js maintainability event-driven
Web Api Help Page XML comments from more than 1 files

I have different plugins in my Web api project with their own XML docs, and have one centralized Help page, …

asp.net asp.net-web-api documentation asp.net-web-api-helppages