Changeset 129:8bebaad67567 in finroc_plugins_structure


Ignore:
Timestamp:
06.02.2020 11:07:50 (3 weeks ago)
Author:
Max Reichardt <max.reichardt@…>
Branch:
17.03
Phase:
public
Message:

Corrects typos in inline documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • tComponent.h

    r123 r129  
    163163   * Components may have a std::vector of ports in their interfaces. 
    164164   * This is a convenience method for adjusting the number of ports in such vectors. 
    165    * If the number of ports is equals to the 'number_of_ports' parameters, nothing is done. 
    166    * If the number of ports is greater than the 'number_of_ports' parameters, ports at the back are deleted until the vector has the desired size. 
    167    * If the number of ports is smaller than the 'number_of_ports' parameters, ports at the back are appended. 
     165   * If the number of ports is equal to the 'number_of_ports' parameter, nothing is done. 
     166   * If the number of ports is greater than the 'number_of_ports' parameter, ports at the back are deleted until the vector has the desired size. 
     167   * If the number of ports is smaller than the 'number_of_ports' parameter, ports are added to the vector. 
    168168   * Ports are named: <common_prefix><start_index><common_postfix>, <common_prefix><start_index + 1><common_postfix>, ..., <common_prefix><start_index + number_of_ports - 1><common_postfix> 
    169169   * 
     
    172172   * \param common_prefix Common prefix of all ports names (see port naming above; add a pending space if you like to have a space between prefix and index) 
    173173   * \param start_index Number in name of first port in vector (incremented for each further port) 
    174    * \param start_index Common postfix of all ports names (see port naming above; could be e.g. ']') 
     174   * \param common_postfix Common postfix of all ports names (see port naming above; could be e.g. ']') 
    175175   */ 
    176176  template <typename TPort> 
Note: See TracChangeset for help on using the changeset viewer.