summaryrefslogtreecommitdiff
path: root/src/bin/eolian/docs_generator.h
blob: 0f4424a3f22b87a81548ed716862d9f24cc90614 (plain) (blame)
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
#ifndef DOCS_GENERATOR_H
#define DOCS_GENERATOR_H

#include <Eina.h>
#include <Eolian.h>

/*
 * @brief Generate standard documentation
 *
 * @param[in] doc the documentation
 * @param[in] indent by how many spaces to indent the comment from second line
 * @param[in] use_legacy whether to use legacy names
 *
 * @return A documentation comment
 *
 */
Eina_Strbuf *docs_generate_full(const Eolian_Documentation *doc, int indent, Eina_Bool use_legacy);

/*
 * @brief Generate function documentation
 *
 * @param[in] fid te function
 * @param[in] type the function type (either METHOD, PROP_GET, PROP_SET)
 * @param[in] indent by how many spaces to indent the comment from second line
 * @param[in] use_legacy whether to use legacy names
 *
 * @return A documentation comment
 *
 */
Eina_Strbuf *docs_generate_function(const Eolian_Function *fid, Eolian_Function_Type ftype, int indent, Eina_Bool use_legacy);

#endif