blob: 66dc14f22cafc0cde19ef10b644127779d675c66 (
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
|
If you want to document one of the epiphany files you can do it
by the following steps:
- Add documentation headers to the .c file public functions
For example:
/**
* ephy_session_autoresume:
* @session: a #EphySession
*
* Resume a crashed session when necessary (interactive)
*
* Return value: %TRUE if at least a window has been opened
**/
gboolean
ephy_session_autoresume (EphySession *session)
I dont think gtk-doc has a syntax document, though gtk is
a good example to look at.
- If it's a GObject add the get_type function and include
the .h in doc/reference/epiphany.types.
- Remove the .h from the IGNORE_HFILES section of
doc/reference/Makefile.am
- Clean current docs build using "make maintainer-clean-local"
- Build and commit both the modified .c and the sgml generated
in doc/reference/tmpl.
|
