# HG changeset patch # User Oleksandr Gavenko # Date 1313357850 -10800 # Node ID be069cecf0f40d9104bea017486769141af91657 # Parent 006376b43b083da67ce9a0557bfcdf09ab807938 Convert some files to RST. diff -r 006376b43b08 -r be069cecf0f4 doc-gen.rst --- a/doc-gen.rst Sun Aug 14 15:27:06 2011 +0300 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,10 +0,0 @@ --*- mode: outline; coding: utf-8; -*- - -* Doxygen. - - $ sudo apt-get install doxygen - $ sudo apt-get install doxygen-gui - -Graphical wizard called as: - - $ doxywizard diff -r 006376b43b08 -r be069cecf0f4 doxygen.rst --- a/doxygen.rst Sun Aug 14 15:27:06 2011 +0300 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ --*- mode: outline; coding: utf-8 -*- - -* Doxygen simple workflow. - - $ cd $proj - $ doxygen -g $proj.cfg # generate basic config file - -Edit $proj.cfg. Some essential settings: - - PROJECT_NAME = my-proj - OUTPUT_DIRECTORY = my - OUTPUT_LANGUAGE = English - INPUT = my.h my.hpp dir/ - INPUT_ENCODING = UTF-8 - FILE_PATTERNS = - RECURSIVE = NO - GENERATE_HTML = YES - -* Generate .chm from doxygen. - -Check doxygen config file for: - - GENERATE_HTMLHELP = YES - CHM_FILE = my.chm - CHM_INDEX_ENCODING = Windows-1251 - -Run 'doxygen' and 'hhc.exe' on generated 'index.hhp' - - $ doxygen $proj.cfg - $ cd $proj/html # here gone doxygen html output - $ hhc.exe index.hhp -