wael
/
C_lib
1
0
Fork 0
Code Releases Activity

Added documentation for the function timing struct.

This commit is contained in:
wael 2021-09-13 22:53:00 +03:00
parent 373828db8c
commit 9cfb0f81b5
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generate_docs.sh
View File

@ -5,7 +5,7 @@
# Prompt user at the start for what type they want.
# Specify the file paths, in the order where they should be built.
filepaths=('nodes/single_node.h.ms' 'nodes/double_node.h.ms' 'nodes/tree_node.h.ms' 'strings/strzcpy.ms' 'stack/stack.h.ms' 'linked_lists/double_linked_list.h.ms' 'linked_lists/single_linked_list.h.ms')
filepaths=('nodes/single_node.h.ms' 'nodes/double_node.h.ms' 'nodes/tree_node.h.ms' 'strings/strzcpy.ms' 'stack/stack.h.ms' 'linked_lists/double_linked_list.h.ms' 'linked_lists/single_linked_list.h.ms' 'utils/time_function.h.ms')
# Prompt the user for the option they want (pdf/html/utf8).
echo "Please choose an output option: pdf, html or utf8."

23
docs/utils/time_function.h.ms Normal file
View File

@ -0,0 +1,23 @@
.DA
.TL
time_function.h
.AU
Wael Karram
.AB no
Documentation for time_function.h
.AE
.ND
.PP
This header defines a function_run_time struct, with the prepoccessor variable TIME_FUNCTION_H used as an include guard.
.br
Defines a single struct
.UL function_run_time \0which
has the fields
.I "char *name" \0and
.I "double time" ,
the former of which is used to store the function's name, and the latter is used to store the runtime measurement.