mirror of
https://github.com/Sani7/remote-ui.git
synced 2026-10-27 06:01:14 +01:00
server doxygen
Add documentation to the server
This commit is contained in:
@@ -7,18 +7,67 @@ class UI_hex_spinbox : public UI_item
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a UI hex spinbox object
|
||||
*
|
||||
* @param parent The parent QObject
|
||||
*/
|
||||
explicit UI_hex_spinbox(QObject *parent = nullptr);
|
||||
/**
|
||||
* @brief Construct a UI hex spinbox object
|
||||
*
|
||||
* @param min The minimum value
|
||||
* @param max The maximum value
|
||||
* @param value The initial value
|
||||
* @param parent The parent QObject
|
||||
*/
|
||||
UI_hex_spinbox(double min, double max, double value, QObject *parent = nullptr);
|
||||
|
||||
/**
|
||||
* @brief Set the value of the hex spinbox
|
||||
*
|
||||
* @param value The value to set
|
||||
*/
|
||||
void set_value(double value) override;
|
||||
/**
|
||||
* @brief Get the value of the hex spinbox
|
||||
*
|
||||
* @return double The current value
|
||||
*/
|
||||
double value() const;
|
||||
|
||||
/**
|
||||
* @brief Get the minimum value of the hex spinbox
|
||||
*
|
||||
* @return double The minimum value
|
||||
*/
|
||||
double min() const;
|
||||
/**
|
||||
* @brief Get the maximum value of the hex spinbox
|
||||
*
|
||||
* @return double The maximum value
|
||||
*/
|
||||
double max() const;
|
||||
|
||||
/**
|
||||
* @brief Deserialize the hex spinbox from JSON
|
||||
*
|
||||
* @param j The JSON object
|
||||
*/
|
||||
void from_json(const json &j) override;
|
||||
/**
|
||||
* @brief Serialize the hex spinbox to JSON
|
||||
*
|
||||
* @param id The id of the hex spinbox
|
||||
* @return json The JSON representation of the hex spinbox
|
||||
*/
|
||||
json to_json(size_t id) const override;
|
||||
signals:
|
||||
/**
|
||||
* @brief Signal emitted when the hex spinbox value changes
|
||||
*
|
||||
* @param value The new value
|
||||
*/
|
||||
void changed(double value);
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user