About the Uncrustify Documentation Project

Uncrustify doesn't provide a real documentation.

> uncrustify --help
  Usage:
  uncrustify [options] [files ...]
  ...
  There are currently 850 options and minimal documentation.
  Try UniversalIndentGUI and good luck.

Because Uncrustify users are developers, Uncrustify source code is often used as the official documentation.
The best you can get (outside the code) is this documentation directory. The wiki is about the internal design of uncrustify.

The Uncrustify Documentation Project is an independant effort to make more obvious the effect of each of the ~850 options.

This project will provide 3 sets of data:

• An html page for each option. A part is done automatically, but the examples are provided manually.
• Several indexes to access to these pages. These indexes are generated automatically.
• A table comparing several well know configurations. This page is generated automatically.

... and some pages to explain how to use this documentation and how to contribute.

All this documentation is provided under the Creative Common Attribution-NonCommercial-ShareAlike 4.0 International licence.

This project is in the second stage of its development:

1. The first stage (Jan...Mar 2024), consisting of the automatic build of html files based on the information produced by uncrustify, has been largely completed.
2. The second stage (Apr/2024...) consists of manually providing examples of code adapted to each option, and there are over 800 of them!...

Here's the list of issues/PRs I submitted to the Uncrustify tracking system that helped me complete this documentation project.