Doxygen update: removed documentation from inherited classes as INHERTIC_DOCS is enabled in doxygen config. Reduces copy-paste and eases maintenance.

Author: Teppo Järvelin

features/cellular/framework/API/CellularNetwork.h

@@ -374,7 +374,7 @@ class CellularNetwork : public NetworkInterface
      */
     virtual int get_3gpp_error() = 0;
 
-    /** Get the operator params
+    /** Get the operator parameters.
      *
      *  @param format format of the operator field
      *  @param operator_params applicable operator param fields filled

features/cellular/framework/AT/AT_CellularDevice.h

@@ -46,12 +46,6 @@ class AT_CellularDevice : public CellularDevice
 protected:
     ATHandler *_atHandlers;
 
-    /** Get the athandler. If the given fh is already used with existing athandler, instance to that athander is returned.
-     *  Otherwise new athander is created.
-     *
-     *  @param fh  FileHandle to be used with the ATHandler
-     *  @return    pointer to ATHandler
-     */
     ATHandler *get_at_handler(FileHandle *fh);
 
     /** Releases the given at_handler. If last reference to at_hander then it's deleted.
@@ -61,82 +55,32 @@ class AT_CellularDevice : public CellularDevice
     void release_at_handler(ATHandler* at_handler);
 
 public: // CellularDevice
-    /** Create new CellularNetwork interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularNetwork.
-     */
     virtual CellularNetwork *open_network(FileHandle *fh);
 
-    /** Create new CellularSMS interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularSMS.
-     */
     virtual CellularSMS *open_sms(FileHandle *fh);
 
-    /** Create new CellularPower interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularPower.
-     */
     virtual CellularPower *open_power(FileHandle *fh);
 
-    /** Create new CellularSIM interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularSIM.
-     */
     virtual CellularSIM *open_sim(FileHandle *fh);
 
-    /** Create new CellularMultiplexer interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularMultiplexer.
-     */
     virtual CellularMultiplexer *open_multiplexer(FileHandle *fh);
 
-    /** Create new CellularInformation interface.
-     *
-     *  @param fh    filehandle used in communication to modem. Can be for example UART handle.
-     *  @return      New instance of interface CellularInformation.
-     */
     virtual CellularInformation *open_information(FileHandle *fh);
 
-    /** Closes the opened CellularNetwork by deleting the CellularNetwork instance.
-     */
     virtual void close_network();
 
-    /** Closes the opened CellularNetwork by deleting the CellularSMS instance.
-     */
     virtual void close_sms();
 
-    /** Closes the opened CellularNetwork by deleting the CellularPower instance.
-     */
     virtual void close_power();
 
-    /** Closes the opened CellularNetwork by deleting the CellularSIM instance.
-     */
     virtual void close_sim();
 
-    /** Closes the opened CellularNetwork by deleting the CellularMultiplexer instance.
-     */
     virtual void close_multiplexer();
 
-    /** Closes the opened CellularNetwork by deleting the CellularInformation instance.
-     */
     virtual void close_information();
 
-    /** Set the default response timeout.
-     *
-     *  @param timeout    milliseconds to wait response from modem
-     */
     virtual void set_timeout(int timeout);
 
-    /** Get network stack.
-     *
-     *  @return network stack
-     */
     virtual NetworkStack *get_stack();
 
 protected:

features/cellular/framework/AT/AT_CellularInformation.h

@@ -35,28 +35,10 @@ class AT_CellularInformation : public CellularInformation, public AT_CellularBas
     virtual ~AT_CellularInformation();
 
 public:
-    /** Request manufacturer identification of cellular device
-     *
-     *  @param buf      manufacturer identification
-     *  @param buf_size max length of manufacturer identification is 2048 characters
-     *  @return         on success read character count, on failure negative error code
-     */
     virtual nsapi_size_or_error_t get_manufacturer(char *buf, size_t buf_size);
 
-    /** Request model identification of cellular device
-     *
-     *  @param buf      model identification
-     *  @param buf_size max length of model identification is 2048 characters
-     *  @return         on success read character count, on failure negative error code
-     */
     virtual nsapi_size_or_error_t get_model(char *buf, size_t buf_size);
 
-    /** Request revision identification of cellular device
-     *
-     *  @param buf      revision identification
-     *  @param buf_size max length of revision identification is 2048 characters
-     *  @return         on success read character count, on failure negative error code
-     */
     virtual nsapi_size_or_error_t get_revision(char *buf, size_t buf_size);
 
 protected:

features/cellular/framework/AT/AT_CellularMultiplexer.h

@@ -35,10 +35,6 @@ class AT_CellularMultiplexer : public CellularMultiplexer, public AT_CellularBas
     virtual ~AT_CellularMultiplexer();
 
 public:
-    /** Starts modem multiplexer mode specified by 3GPP TS 27.010.
-     *
-     *  @return zero on success, negative error code on failure
-     */
     virtual nsapi_error_t multiplexer_mode_start();
 };
 

features/cellular/framework/AT/AT_CellularNetwork.h

@@ -43,225 +43,68 @@ class AT_CellularNetwork : public CellularNetwork, public AT_CellularBase
 
 public: // NetworkInterface
 
-    /** Set the cellular network APN and credentials
-     *
-     *  @param apn      Optional name of the network to connect to
-     *  @param username Optional username for the APN
-     *  @param password Optional password fot the APN
-     *  @return         0 on success, negative error code on failure
-     */
     virtual nsapi_error_t set_credentials(const char *apn,
                                           const char *username = 0, const char *password = 0);
 
-    /** Set the cellular network APN and credentials
-     *
-     *  @param apn      Name of the network to connect to
-     *  @param type     Authentication type to use
-     *  @param username Optional username for the APN
-     *  @param password Optional password fot the APN
-     *  @return         0 on success, negative error code on failure
-     */
     virtual nsapi_error_t set_credentials(const char *apn, AuthenticationType type,
                 const char *username = 0, const char *password = 0);
 
-    /** Start the interface. Attempts to connect to a cellular network.
-     *
-     *  @param apn      Optional name of the network to connect to
-     *  @param username Optional username for your APN
-     *  @param password Optional password for your APN
-     *  @return         0 on success, negative error code on failure
-     */
     virtual nsapi_error_t connect(const char *apn,
                                   const char *username = 0, const char *password = 0);
 
-    /** Start the interface. Attempts to connect to a cellular network.
-     *
-     *  @return 0 on success, negative error code on failure
-     */
     virtual nsapi_error_t connect();
 
-    /** Stop the interface
-     *
-     *  @return 0 on success, negative error code on failure
-     */
     virtual nsapi_error_t disconnect();
 
 protected:
-    /** Provide access to the NetworkStack object
-     *
-     *  @return The underlying NetworkStack object
-     */
     virtual NetworkStack *get_stack();
 
 public: // CellularNetwork
-    /** Request registering to network.
-     *
-     *  @param plmn     format is in numeric format or 0 for automatic network registration
-     *  @return         zero on success
-     */
     virtual nsapi_error_t set_registration(const char *plmn = 0);
 
-    /**
-     * Gets the network registration status.
-     * @param type      see RegistrationType values
-     * @param status    see RegistrationStatus values
-     * @return zero on success
-     */
     virtual nsapi_error_t get_registration_status(RegistrationType type, RegistrationStatus &status);
 
-    /** Request attach to network.
-     *
-     *  @param timeout milliseconds to wait for attach response
-     *  @return        zero on success
-     */
     virtual nsapi_error_t set_attach(int timeout = 10*1000);
 
-    /** Request attach status from network.
-     *
-     *  @param status see AttachStatus values
-     *  @return       zero on success
-     */
     virtual nsapi_error_t get_attach(AttachStatus &status);
 
-    /** Get APN rate control.
-     *
-     *  @remark optional params are not updated if not received from network, so use good defaults
-     *
-     *  @param reports       Additional exception reports at maximum rate reached are allowed to be sent [optional]
-     *  @param time_unit     Uplink time unit with values 0=unrestricted, 1=minute, 2=hour, 3=day, 4=week [optional]
-     *  @param uplink_rate   Maximum number of messages per timeUnit [optional]
-     *  @return              zero on success
-     */
     virtual nsapi_error_t get_rate_control(CellularNetwork::RateControlExceptionReports &reports,
         CellularNetwork::RateControlUplinkTimeUnit &time_unit, int &uplink_rate);
 
-    /** Get backoff timer value
-     *
-     *  @param backoff_time Backoff timer value associated with PDP APN in seconds
-     *  @return             zero on success
-     */
     virtual nsapi_error_t get_backoff_time(int &backoff_time);
 
-    /** Get notified if the connection gets lost
-     *
-     *  @param status_cb         user defined callback
-     */
     virtual void attach(Callback<void(nsapi_event_t, intptr_t)> status_cb);
 
-    /** Get the connection status
-     *
-     *  @return         The connection status according to ConnectionStatusType
-     */
     virtual nsapi_connection_status_t get_connection_status() const;
 
-    /** Set blocking status of connect() which by default should be blocking
-     *
-     *  @param blocking true if connect is blocking
-     *  @return         0 on success, negative error code on failure
-     */
     virtual nsapi_error_t set_blocking(bool blocking);
 
-    /** Get the local IP address
-     *
-     *  @return         Null-terminated representation of the local IP address
-     *                  or null if no IP address has been received
-     */
     virtual const char *get_ip_address();
 
-    /** Sets radio access technology.
-     *
-     *  @param op_rat Radio access technology
-     *  @return       zero on success
-     */
     virtual nsapi_error_t set_access_technology(operator_t::RadioAccessTechnology op_rat);
 
-    /** Scans for operators module can reach.
-     *
-     *  @param operators Container of reachable operators and their access technologies
-     *  @param ops_count Number of found operators
-     *  @return          zero on success
-     */
     virtual nsapi_error_t scan_plmn(operList_t &operators, int &ops_count);
 
-    /** Set CIoT optimizations.
-     *
-     *  @param supported_opt Supported CIoT EPS optimizations.
-     *  @param preferred_opt Preferred CIoT EPS optimizations.
-     *  @return zero on success
-     */
     virtual nsapi_error_t set_ciot_optimization_config(Supported_UE_Opt supported_opt,
                                                        Preferred_UE_Opt preferred_opt);
 
-    /** Get CIoT optimizations.
-     *
-     *  @param supported_opt Supported CIoT EPS optimizations.
-     *  @param preferred_opt Preferred CIoT EPS optimizations.
-     *  @return zero on success
-     */
     virtual nsapi_error_t get_ciot_optimization_config(Supported_UE_Opt& supported_opt,
                                                        Preferred_UE_Opt& preferred_opt);
 
+    virtual nsapi_error_t set_stack_type(nsapi_ip_stack_t stack_type);
 
-    /** Set the pdn type to be used
-     *
-     *  @param stack_type the stack type to be used.
-     *  @return NSAPI_ERROR_OK on success
-     */
-     virtual nsapi_error_t set_stack_type(nsapi_ip_stack_t stack_type);
+    virtual nsapi_ip_stack_t get_stack_type();
 
-    /** Get the pdn type in use
-     *
-     *  @return stack type
-     */
-     virtual nsapi_ip_stack_t get_stack_type();
+    virtual nsapi_error_t get_pdpcontext_params(pdpContextList_t& params_list);
 
-    /** Get the relevant information for an active non secondary PDP context.
-     *
-     *  @remark optional params are not updated if not received from network.
-     *
-     *  @param params_list  reference to linked list which is filled on successful call
-     *  @return             0 on success, negative error code on failure
-     */
-     virtual nsapi_error_t get_pdpcontext_params(pdpContextList_t& params_list);
-
-    /** Get extended signal quality parameters.
-     *
-     *  @param rxlev signal strength level
-     *  @param ber bit error rate
-     *  @param rscp signal code power
-     *  @param ecno ratio of the received energy per PN chip to the total received power spectral density
-     *  @param rsrq signal received quality
-     *  @param rsrp signal received power
-     *  @return NSAPI_ERROR_OK on success, negative error code on failure
-     */
     virtual nsapi_error_t get_extended_signal_quality(int &rxlev, int &ber, int &rscp, int &ecno, int &rsrq, int &rsrp);
 
-    /** Get signal quality parameters.
-     *
-     *  @param rssi signal strength level
-     *  @param ber bit error rate
-     *  @return NSAPI_ERROR_OK on success, negative error code on failure
-     */
     virtual nsapi_error_t get_signal_quality(int &rssi, int &ber);
 
-    /** Get cell id.
-     *
-     *  @param cell_id cell id
-     *  @return NSAPI_ERROR_OK on success, negative error code on failure
-     */
     virtual nsapi_error_t get_cell_id(int &cell_id);
 
-    /** Get the last 3GPP error code
-     *  @return see 3GPP TS 27.007 error codes
-     */
     virtual int get_3gpp_error();
 
-    /** Get the operator params
-     *
-     *  @param format format of the operator field
-     *  @param operator_params applicable operator param fields filled
-     *  @return NSAPI_ERROR_OK on success, negative error code on failure
-     */
     virtual nsapi_error_t get_operator_params(int &format, operator_t &operator_params);
 
 protected:
@@ -279,7 +122,7 @@ class AT_CellularNetwork : public CellularNetwork, public AT_CellularBase
      */
     virtual bool has_registration(RegistrationType reg_type);
 
-    /** Sets access technology to be scanned.
+    /** Sets access technology to be scanned. Modem specific implementation.
      *
      *  @param op_rat Access technology
      *