X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=HACKING;h=80382ed4ea71d7e91b79ec4c2d74e78d3903f333;hb=9df9c90dff56b830464b7a5262b4101e31704777;hp=05fb69c67955fd8b7aa5acd76b8e7594670cc936;hpb=b9dcc0f75569396fee79bae315d86861cc775cd8;p=platform%2Fupstream%2Fconnman.git diff --git a/HACKING b/HACKING index 05fb69c..80382ed 100644 --- a/HACKING +++ b/HACKING @@ -107,38 +107,3 @@ can get very complex. The first detail inside "{ ... }" is the interface name (without its service name prefix). The second detail inside "[ ... ]" is the object path. And after that it is followed by a key and value of the property that changed. - - -Generating source code documentation -==================================== - -The source code is annotated using the gtk-doc style documentation. This -allows an easy way of generating API documentation. The "bootstrap-configure" -script will use the "--enable-gtk-doc" configure to enable the generation of -the documentation. - -To make the gtk-doc process work, the gtk-doc tools need to be installed. -Every distribution should provide a package for this, but the naming of the -package might be different: - - Debian - # apt-get install gtk-doc-tools - - Ubuntu - # apt-get install gtk-doc-utils - - Fedora - # yum install gtk-doc - -In case "bootstrap-configure" is not used, the manual steps for generating -the documentation files are like this: - - Configuring the repository - # ./configure --enable-gtk-doc - - Generate the documentation - # cd doc && make - - View documentation - # firefox doc/html/index.html -