diff --git a/Doxyfile b/Doxyfile index 82ad9703..5a4bfdfd 100644 --- a/Doxyfile +++ b/Doxyfile @@ -728,7 +728,7 @@ TREEVIEW_WIDTH = 250 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = NO +GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -782,7 +782,7 @@ PDF_HYPERLINKS = NO # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. -USE_PDFLATEX = NO +USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep diff --git a/include/ecrt.h b/include/ecrt.h index 1e1b93bc..5a43de8b 100644 --- a/include/ecrt.h +++ b/include/ecrt.h @@ -58,15 +58,22 @@ typedef struct ec_domain ec_domain_t; struct ec_slave; typedef struct ec_slave ec_slave_t; +/** + Initialization type for field registrations. + This type is used as a parameter for the ec_domain_register_field_list() + function. +*/ + typedef struct { - void **data_ptr; - const char *slave_address; - const char *vendor_name; - const char *product_name; - const char *field_name; - unsigned int field_index; - unsigned int field_count; + void **data_ptr; /**< address of the process data pointer */ + const char *slave_address; /**< slave address string (see + ecrt_master_get_slave()) */ + const char *vendor_name; /**< vendor name */ + const char *product_name; /**< product name */ + const char *field_name; /**< data field name */ + unsigned int field_index; /**< index in data fields with same name */ + unsigned int field_count; /**< number of data fields with same name */ } ec_field_init_t;