[thirdparty/sarg.git] / documentation / index.txt

/*!\file index.c
\brief Create the HTML index of the reports
*/


/*! \fn void make_index(void)
Create the main HTML index of the available reports.
*/


/*! \fn static void make_date_index(void)
Create an index with the reports sorted hierarchicaly by date. A first level lists
the year. The second level lists the months (possibly a range) and the third level
lists the days or day ranges.
*/


/*! \fn static void make_file_index(void)
Create an index with the reports sorted by directory name. There is only one level
which is the name of the directory containing the report.
*/


/*! \fn static void file_index_to_date_index(const char *entry)
Convert a report from the file tree into a report for a date tree.

This function is invoked for each directory entry when ::IndexTree request a date index.
The function has to opportunity to convert a previous entry created when ::IndexTree was
requesting a file index.

\param entry The directory name that may require to be converted.
*/


/*! \fn static void date_index_to_file_index(const char *entry)
Convert a report from the date tree into a report for a file tree.

This function is invoked for each directory entry when ::IndexTree request a file index.
The function has to opportunity to convert a previous entry created when ::IndexTree was
requesting a date index.

\param entry The directory name that may require to be converted.
*/
Commit	Line	Data
06ced858 FM	1	/*!\file index.c
	2	\brief Create the HTML index of the reports
	3	*/
	4
	5
	6
	7
	8	/*! \fn void make_index(void)
	9	Create the main HTML index of the available reports.
	10	*/
	11
	12
	13
	14
	15
b25b96fe FM	16	/*! \fn static void make_date_index(void)
	17	Create an index with the reports sorted hierarchicaly by date. A first level lists
	18	the year. The second level lists the months (possibly a range) and the third level
	19	lists the days or day ranges.
	20	*/
	21
	22
	23
	24
	25
	26	/*! \fn static void make_file_index(void)
	27	Create an index with the reports sorted by directory name. There is only one level
	28	which is the name of the directory containing the report.
	29	*/
	30
	31
	32
	33
	34
06ced858 FM	35	/! \fn static void file_index_to_date_index(const char entry)
	36	Convert a report from the file tree into a report for a date tree.
	37
	38	This function is invoked for each directory entry when ::IndexTree request a date index.
	39	The function has to opportunity to convert a previous entry created when ::IndexTree was
	40	requesting a file index.
	41
	42	\param entry The directory name that may require to be converted.
	43	*/
	44
	45
	46
	47
	48
	49	/! \fn static void date_index_to_file_index(const char entry)
	50	Convert a report from the date tree into a report for a file tree.
	51
	52	This function is invoked for each directory entry when ::IndexTree request a file index.
	53	The function has to opportunity to convert a previous entry created when ::IndexTree was
	54	requesting a date index.
	55
	56	\param entry The directory name that may require to be converted.
	57	*/