tips: doxygen.rst@e95731eef030 (annotated)

1334 9bf0d5a1f0cf Include common header with quick links. Oleksandr Gavenko <gavenkoa@gmail.com> parents: 945 diff changeset	1	.. -- coding: utf-8; --
945 972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	2
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	3	==========
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	4	Doxygen.
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	5	==========
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	6	.. contents::
1905 fba288d59662 Include only local subsections into TOC. This prevent duplication of Oleksandr Gavenko <gavenkoa@gmail.com> parents: 1334 diff changeset	7	:local:
945 972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	8
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	9	Installing.
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	10	===========
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	11	::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	12
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	13	$ sudo apt-get install doxygen
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	14	$ sudo apt-get install doxygen-gui
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	15
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	16	Graphical wizard called as::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	17
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	18	$ doxywizard
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	19
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	20	Doxygen simple workflow.
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	21	========================
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	22	::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	23
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	24	$ cd $proj
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	25	$ doxygen -g $proj.cfg # generate basic config file
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	26
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	27	Edit $proj.cfg. Some essential settings::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	28
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	29	PROJECT_NAME = my-proj
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	30	OUTPUT_DIRECTORY = my
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	31	OUTPUT_LANGUAGE = English
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	32	INPUT = my.h my.hpp dir/
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	33	INPUT_ENCODING = UTF-8
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	34	FILE_PATTERNS =
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	35	RECURSIVE = NO
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	36	GENERATE_HTML = YES
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	37
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	38	Generate .chm from doxygen.
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	39	===========================
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	40
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	41	Check doxygen config file for::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	42
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	43	GENERATE_HTMLHELP = YES
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	44	CHM_FILE = my.chm
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	45	CHM_INDEX_ENCODING = Windows-1251
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	46
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	47	Run 'doxygen' and 'hhc.exe' on generated 'index.hhp'::
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	48
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	49	$ doxygen $proj.cfg
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	50	$ cd $proj/html # here gone doxygen html output
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	51	$ hhc.exe index.hhp
972852ff3ade change mode to 644 Oleksandr Gavenko <gavenkoa@gmail.com> parents: diff changeset	52

author	Oleksandr Gavenko <gavenkoa@gmail.com>
	Mon, 09 Oct 2017 10:49:36 +0300
changeset 2188	e95731eef030
parent 1912	8b81a8f0f692
permissions	-rw-r--r--