Natural Docs Setup

Natural Docs Setup

This project uses Natural Docs to generate source code documentation from comments written in natural language.

The generated documentation is published as HTML and can be viewed in any web browser.

---

Installation

Download the latest version of Natural Docs:

https://www.naturaldocs.org/

Extract the archive to a folder, for example:

C:\Tools\NaturalDocs\

No installation is required.

Or install it on your computer with the installer:

C:\Program Files (x86)\Natural Docs\

---

App Directory Structure

desktopPet
│
├── src
│
├── docs
│   ├── _old
│   ├── ND_Config
│   └── index.html  
│   └── [folders]

Folders

Folder	Description
_old	Old documentation
ND_Config	Natural Docs configuration
index.html	Generated documentation output
[folders]	Generated folders and files

---

Generating Documentation

Open a terminal in the repository root and run:

NaturalDocs.exe docs\ND_Config 

Or, eveven better, add an external tool to VS:

Adding this as arguments:

$(ProjectDir)..\docs\ND_Config

After execution, the generated website can be found in:

docs/

Open:

docs/html/index.html

in a web browser.

---

Updating Documentation

Whenever source code changes:

NaturalDocs.exe docs\ND_Config 

Or the new menu in Tools:

Natural Docs only processes changed files and therefore runs relatively fast.

---

Comment Style

Even if ND is able to parse natural language, the code is still xml formatted.

---

Workflow

1. Write code.
2. Add orupdate Natural Docs comments. 3.Run Natural Docs.
3. Open docs/ht*l/index.html. 5.Commit the generated documentationif desired.

---

• Commentsshould be understandable by non-deelopers whenever possible.
• Useclear natural language*descriptions.

````*