search

campreilly / UnderSeaModelingLibrary

The Under Sea Modeling Library (USML) is a collection of C++ software development modules for sonar modeling and simulation.
Other
45 stars 22 forks source link

Fix doxygen errors in sensor and eigenverb modules #190

Closed campreilly closed 9 years ago

campreilly commented 9 years ago

Running doxygen exposes a host of issues

[sreilly@sreilly usml]$ doxygen
/home/sreilly/Projects/usml/sensors/receiver_params.cc:16: Warning: no matching class member found for
  receiver_params(int paramsID, double min_freq, double max_freq, const usml::types::seq_vector &frequencies, const std::list< int > &beamList, bool multistatic)
Possible candidates:
  receiver_params::receiver_params(sensor_params::id_type paramsID, double min_freq, double max_freq, const seq_vector &frequencies, const beam_pattern_list &beam_list, bool multistatic=true)
  receiver_params::receiver_params(const receiver_params &other)
/home/sreilly/Projects/usml/ocean/test/ocean_shared_test.cc:4: Warning: included file threads/test/ocean_shared_test.cc is not found. Check your EXAMPLE_PATH
/home/sreilly/Projects/usml/sensors/source_params.h:78: Warning: Found unknown command `\1m'
/home/sreilly/Projects/usml/sensors/test/maps_test.cc:23: Warning: Found unknown command `\updated'
/home/sreilly/Projects/usml/eigenverb/eigenverb_collection.h:39: Warning: argument 'num_volume' of command @param is not found in the argument list of eigenverb_collection::eigenverb_collection(size_t num_volumes)
/home/sreilly/Projects/usml/eigenverb/eigenverb_collection.h:39: Warning: The following parameters of usml::eigenverb::eigenverb_collection::eigenverb_collection(size_t num_volumes) are not documented:
  parameter 'num_volumes'
/home/sreilly/Projects/usml/eigenverb/eigenverb_collection.h:76: Warning: The following parameters of usml::eigenverb::eigenverb_collection::add_eigenverb(const eigenverb &verb, size_t interface) are not documented:
  parameter 'verb'
/home/sreilly/Projects/usml/eigenverb/eigenverb_collection.h:172: Warning: end of comment block while expecting command </pre>
/home/sreilly/Projects/usml/eigenverb/eigenverb_collection.h:172: Warning: end of comment block while expecting command </pre>
/home/sreilly/Projects/usml/eigenverb/envelope_generator.h:33: Warning: argument 'curves' of command @param is not found in the argument list of envelope_generator::generate_envelopes(const eigenverb_collection &source, const eigenverb_collection &receiver, envelope_collection *levels)
/home/sreilly/Projects/usml/eigenverb/envelope_generator.h:33: Warning: The following parameters of usml::eigenverb::envelope_generator::generate_envelopes(const eigenverb_collection &source, const eigenverb_collection &receiver, envelope_collection *levels) are not documented:
  parameter 'levels'
/home/sreilly/Projects/usml/sensors/beam_pattern_solid.cc:11: Warning: Found unknown command `\elem'
/home/sreilly/Projects/usml/sensors/beam_pattern_solid.cc:11: Warning: Found unknown command `\elem'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:37: Warning: argument 'eigenrays' of command @param is not found in the argument list of fathometer_model::fathometer_model(sensor_model::id_type source_id, sensor_model::id_type receiver_id, wposition1 src_pos, wposition1 rcv_pos, const eigenray_list &list)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:37: Warning: The following parameters of usml::sensors::fathometer_model::fathometer_model(sensor_model::id_type source_id, sensor_model::id_type receiver_id, wposition1 src_pos, wposition1 rcv_pos, const eigenray_list &list) are not documented:
  parameter 'list'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:124: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::depth_offset(double depth_offset)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:124: Warning: The following parameters of usml::sensors::fathometer_model::depth_offset(double depth_offset) are not documented:
  parameter 'depth_offset'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:108: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::distance_from_sensor(double distance_from_sensor)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:108: Warning: The following parameters of usml::sensors::fathometer_model::distance_from_sensor(double distance_from_sensor) are not documented:
  parameter 'distance_from_sensor'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:181: Warning: argument 'eigenray_list' of command @param is not found in the argument list of fathometer_model::eigenrays(eigenray_list list)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:181: Warning: The following parameters of usml::sensors::fathometer_model::eigenrays(eigenray_list list) are not documented:
  parameter 'list'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:84: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::receiver_id(sensor_model::id_type receiver_id)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:84: Warning: The following parameters of usml::sensors::fathometer_model::receiver_id(sensor_model::id_type receiver_id) are not documented:
  parameter 'receiver_id'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:164: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::receiver_position(wposition1 position)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:164: Warning: The following parameters of usml::sensors::fathometer_model::receiver_position(wposition1 position) are not documented:
  parameter 'position'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:92: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::slant_range(double slant_range)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:92: Warning: The following parameters of usml::sensors::fathometer_model::slant_range(double slant_range) are not documented:
  parameter 'slant_range'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:68: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::source_id(sensor_model::id_type source_id)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:68: Warning: The following parameters of usml::sensors::fathometer_model::source_id(sensor_model::id_type source_id) are not documented:
  parameter 'source_id'
/home/sreilly/Projects/usml/sensors/fathometer_model.h:148: Warning: argument 'The' of command @param is not found in the argument list of fathometer_model::source_position(wposition1 position)
/home/sreilly/Projects/usml/sensors/fathometer_model.h:148: Warning: The following parameters of usml::sensors::fathometer_model::source_position(wposition1 position) are not documented:
  parameter 'position'
/home/sreilly/Projects/usml/sensors/orientation.cc:19: Warning: The following parameters of usml::sensors::orientation::orientation(double heading, double pitch, double roll, vector< double > ref_axis) are not documented:
  parameter 'ref_axis'
/home/sreilly/Projects/usml/sensors/sensor_listener.h:43: Warning: argument 'eigenray_list' of command @param is not found in the argument list of sensor_listener::update_fathometer(int sensorID, eigenray_list *list)
/home/sreilly/Projects/usml/sensors/sensor_listener.h:43: Warning: The following parameters of usml::sensors::sensor_listener::update_fathometer(int sensorID, eigenray_list *list) are not documented:
  parameter 'list'
/home/sreilly/Projects/usml/sensors/sensor_manager.h:35: Warning: Found unknown command `\updated'
/home/sreilly/Projects/usml/sensors/sensor_model.h:161: Warning: argument 'shared_pointer' of command @param is not found in the argument list of sensor_model::eigenverbs() const
/home/sreilly/Projects/usml/sensors/sensor_model.cc:220: Warning: Found unknown command `\params'
/home/sreilly/Projects/usml/sensors/sensor_model.cc:233: Warning: Found unknown command `\params'
/home/sreilly/Projects/usml/sensors/sensor_model.cc:83: Warning: argument 'orientation' of command @param is not found in the argument list of sensor_model::update_sensor(const wposition1 &position, const orientation &orient, bool force_update=false)
/home/sreilly/Projects/usml/sensors/sensor_model.cc:83: Warning: The following parameters of usml::sensors::sensor_model::update_sensor(const wposition1 &position, const orientation &orient, bool force_update=false) are not documented:
  parameter 'orient'
/home/sreilly/Projects/usml/sensors/sensor_pair.cc:28: Warning: argument 'eigenray_list' of command @param is not found in the argument list of sensor_pair::update_fathometer(sensor_model::id_type sensorID, eigenray_list *list)
/home/sreilly/Projects/usml/sensors/sensor_pair.cc:28: Warning: The following parameters of usml::sensors::sensor_pair::update_fathometer(sensor_model::id_type sensorID, eigenray_list *list) are not documented:
  parameter 'list'
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:482: Warning: argument 'sensor' of command @param is not found in the argument list of sensor_pair_manager::add_multistatic_receiver(sensor_model *receiver)
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:482: Warning: The following parameters of usml::sensors::sensor_pair_manager::add_multistatic_receiver(sensor_model *receiver) are not documented:
  parameter 'receiver'
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:313: Warning: argument 'receiverID' of command @param is not found in the argument list of sensor_pair_manager::add_sensor(sensor_model *sensor)
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:557: Warning: argument 'sensor' of command @param is not found in the argument list of sensor_pair_manager::remove_multistatic_receiver(sensor_model *receiver)
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:557: Warning: The following parameters of usml::sensors::sensor_pair_manager::remove_multistatic_receiver(sensor_model *receiver) are not documented:
  parameter 'receiver'
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:151: Warning: argument 'fathometrs' of command @param is not found in the argument list of sensor_pair_manager::write_fathometers(fathometer_model::fathometer_package fathometers, const char *filename)
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:155: Warning: Found unknown command `\params'
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.cc:151: Warning: The following parameters of usml::sensors::sensor_pair_manager::write_fathometers(fathometer_model::fathometer_package fathometers, const char *filename) are not documented:
  parameter 'fathometers'
  parameter 'filename'
/home/sreilly/Projects/usml/sensors/sensor_pair_manager.h:366: Error: Unexpected character `"'
/home/sreilly/Projects/usml/sensors/sonobuoy.h:16: Warning: Found unknown command `\created'
/home/sreilly/Projects/usml/sensors/source_params.h:40: Warning: Found unknown command `\1m'
/home/sreilly/Projects/usml/sensors/source_params.h:78: Warning: Found unknown command `\1m'
/home/sreilly/Projects/usml/sensors/source_params.h:87: Warning: Found unknown command `\1m'
This is pdfTeXk, Version 3.141592-1.40.3 (Web2C 7.5.6)
 %&-line parsing enabled.
entering extended mode
(./_formulas.tex
LaTeX2e <2005/12/01>
Babel <v3.8h> and hyphenation patterns for english, usenglishmax, dumylang, noh
yphenation, arabic, basque, bulgarian, coptic, welsh, czech, slovak, german, ng
erman, danish, esperanto, spanish, catalan, galician, estonian, farsi, finnish,
 french, greek, monogreek, ancientgreek, croatian, hungarian, interlingua, ibyc
us, indonesian, icelandic, italian, latin, mongolian, dutch, norsk, polish, por
tuguese, pinyin, romanian, russian, slovenian, uppersorbian, serbian, swedish, 
turkish, ukenglish, ukrainian, loaded.

There are also many places where:

image

campreilly commented 9 years ago

In all of the other modules, the directory off usml is synonymous with the module. The sensors module does not follow that pattern.

islanderjtn commented 9 years ago

Resolved by #202