Skip to content

Betty doc usage

Jump to bottom
Alexandre Gautier edited this page Oct 12, 2016 · 3 revisions

To check your C source files or C header files documentation, you can run betty-doc script as follows:

./betty-doc.pl file

Examples:

./betty-doc.pl main.c
./betty-doc.pl main.c crack_passwd.c utils.h
./betty-doc.pl src/*.c include/*.h

You can see all available options for betty-doc by running the script as follows:

./betty-doc.pl -h

Home

0. Betty cli

0.1 - Betty-style usage

0.2 - Betty-doc usage

0.3 - References

1. Coding style

1.1 - Indentation

1.2 - Breaking long lines and strings

1.3 - Placing Braces

1.4 - Placing Spaces

1.5 - Naming

1.6 - Functions

1.7 - Commenting

1.8 - Macros and Enums

1.9 - Header files

2. Documentation

2.1 - Functions

2.2 - Data structures

3. Tools

3.1 - Emacs

3.2 - Vim

3.3 - Atom

Clone this wiki locally