blob: 7682579b6393b1ad63d1b0003e868e9fcfa5f241 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# SCRUBS - Let's Prepare The Operation
Scrubs is a little documentation tool written in POSIX-Shell. It should make easier to work in teams in a suckless way, without having to it without any documentation.
## Features
There are two kinds of tags which are displayed in scrubs, `DOC` and `TODO`.
`DOC` is used to document your functions or classes. It has the following structur:
``` c++
/** DOC
* @type function
* @name some_random_function
*
* @param input * data
* the input data for processing
*
* @return output
*
* @description
* Here you have the function description.
* It is allowed to have multiple lines.
* Isn't that cool?
*/
```
The `TODO` tag has the following structur:
``` c++
/** TODO
* @category some_bug
*
* @description
* Some weird bug lol
* what is this???
*/
```
*For more examples see `example.cpp`*
## Install
There is a *Makefile* so you are able to install `scrubs` with:
``` bash
sudo make install
```
Note that if you want to use the `search` functionality you have to install `fzf`.
To uninstall
``` bash
sudo make uninstall
```
|
