he-hesce
commented
7 years ago - Bootstrapped Doxygen documentation in evalresp with new doc/Doxyfile, src/evalresp.h, and doc/intro_dox.h. Updated Makefile.am with build targets.
- Added Doxygen skeleton to evresp.h for evalresp private interface. File should be evalrespP.h.
- Added Doxygen docs to evr_spline.h for evalresp cubic spline interpolation interface and adapted existing comments. File should be evalresp_splineP.h.
- Updated log.h, log/to_file.h, and log/to_syslog.h with new Doxygen docs structure for evalresp private logging interface. Files should be logP.h, to_fileP.h, and to_syslogP.h.
- Added Doxygen skeleton to regexp.h for evalresp private regular expressions interface. File should be regexpP.h.
- Added Doxygen skeleton to regmagic.h for evalresp private regular expression interface. File should be regmagicP.h.
- Skipped spline.h as it is borrowed external library code.
- Added Doxygen skeleton to x2r.h, x2r_log.h, x2r_ws.h, and x2r_xml.h. Files should be {x2r,x2r_log,x2r_ws,x2r_xml}P.h.
- Added bootstrap "FIXME" brief description to all undocumented objects.
- Added bootstrap "FIXME" descriptions to undocumented structure attributes.
- Transformed some plain comments to Doxygen documentation comments in evresp.h.
- Used some information from Google Docs "Evalresp functional inventory" to improve Doxygen documentation.
- Documented some FIXMEs structs, struct elements, and macro constants in evresp.h.
- Documented functions (FIXMEs) in regexp.h.
- Documented regmagic.h.
- Documented functions ev_parse_line(), parse_delim_line(), get_field(), test_field(), get_int(), get_double(), check_units(), string_match(), is_int(), is_real(), is_time() in evresp.h.
- Added subgroups to private: alloc, calc, error, file, parse, print, resp, string. Reclassified all functions in evresp.h according to this.
- Documented functions is_IIR_coeffs(), get_line(), next_line(), count_fields(), count_delim_fields(), parse_field(), parse_delim_fields(), check_line(), find_resp(), get_resp(), get_channel() in evresp.h.