tips: doxygen.rst@ad96e87bf403 (annotated)

625 85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	1	-- mode: outline; coding: utf-8 --
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	2
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	3	* Doxygen simple workflow.
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	4
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	5	$ cd $proj
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	6	$ doxygen -g $proj.cfg # generate basic config file
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	7
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	8	Edit $proj.cfg. Some essential settings:
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	9
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	10	PROJECT_NAME = my-proj
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	11	OUTPUT_DIRECTORY = my
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	12	OUTPUT_LANGUAGE = English
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	13	INPUT = my.h my.hpp dir/
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	14	INPUT_ENCODING = UTF-8
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	15	FILE_PATTERNS =
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	16	RECURSIVE = NO
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	17	GENERATE_HTML = YES
85cabce94fda Simple workflow. Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	18
626 ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	19	* Generate .chm from doxygen.
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	20
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	21	Check doxygen config file for:
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	22
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	23	GENERATE_HTMLHELP = YES
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	24	CHM_FILE = my.chm
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	25	CHM_INDEX_ENCODING = Windows-1251
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	26
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	27	Run 'doxygen' and 'hhc.exe' on generated 'index.hhp'
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	28
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	29	$ doxygen $proj.cfg
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	30	$ cd $proj/html # here gone doxygen html output
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	31	$ hhc.exe index.hhp
ad96e87bf403 Generate .chm from doxygen. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 625 diff changeset	32

author	Oleksandr Gavenko <gavenkoa@gmail.com>
	Tue, 26 Oct 2010 11:54:32 +0300
changeset 626	ad96e87bf403
parent 625	85cabce94fda
permissions	-rwxr-xr-x