doc/reference-howto.txt

   1 If you want to document one of the epiphany files you can do it
   2 by the following steps:
   3
   4 - Add documentation headers to the .c file public functions
   5
   6 For example:
   7
   8 /**
   9  * ephy_session_autoresume:
  10  * @session: a #EphySession
  11  *
  12  * Resume a crashed session when necessary (interactive)
  13  *
  14  * Return value: %TRUE if at least a window has been opened
  15  **/
  16 gboolean
  17 ephy_session_autoresume (EphySession *session)
  18
  19 I dont think gtk-doc has a syntax document, though gtk is
  20 a good example to look at.
  21
  22 - If it's a GObject add the get_type function and include
  23 the .h in doc/reference/epiphany.types.
  24
  25 - Remove the .h from the IGNORE_HFILES section of
  26 doc/reference/Makefile.am
  27
  28 - Clean current docs build using "make maintainer-clean-local"
  29
  30 - Build and commit both the modified .c and the sgml generated
  31 in doc/reference/tmpl.