← Back to branch summary

~thomas-voss/platform-api/fix-1202309

« back to all changes in this revision

Viewing changes to include/ubuntu/status.h

Add first wave of doxygen documentation and make the documentation known to the packaging setup.

Approved by PS Jenkins bot, Ricardo Salveti.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/ubuntu/status.h
20
20
#ifndef UBUNTU_STATUS_H_
21
21
#define UBUNTU_STATUS_H_
22
22
 
 
23
/**
 
24
 * \brief Indicates the status of an operation.
 
25
 */
23
26
typedef enum
24
27
{
25
 
        U_STATUS_SUCCESS,
26
 
    U_STATUS_ERROR
27
 
} UStatus;
 
28
    U_STATUS_SUCCESS, ///< Operation finished successfully.
 
29
    U_STATUS_ERROR ///< Operation finished with an error.
 
30
} UbuntuStatus;
 
31
 
 
32
typedef UbuntuStatus UStatus;
28
33
 
29
34
#endif /* UBUNTU_STATUS_H_ */