← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/ubuntu/application/description.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/application/description.h
14
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15
15
 *
16
16
 * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17
 
 *              Thomas Voß <thomas.voss@canonical.com>           
 
17
 *              Thomas Voß <thomas.voss@canonical.com>
18
18
 */
19
19
 
20
20
#ifndef UBUNTU_APPLICATION_DESCRIPTION_H_
27
27
extern "C" {
28
28
#endif
29
29
 
 
30
    /**
 
31
     * \brief Encapsulates properties of an application instance.
 
32
     * \ingroup application_support
 
33
     */
30
34
    typedef void UApplicationDescription;
31
 
    
 
35
 
 
36
    /**
 
37
     * \brief Creates a new instance of application description.
 
38
     * \ingroup application_support
 
39
     * \returns A new application description instance or NULL if not enough memory is available.
 
40
     */
32
41
    UApplicationDescription*
33
42
    u_application_description_new();
34
 
    
 
43
 
 
44
    /**
 
45
     * \brief Destroys an instance of application description and releases all resources.
 
46
     * \ingroup application_support
 
47
     * \param[in] desc The instance to be destroyed.
 
48
     */
35
49
    void
36
50
    u_application_description_destroy(
37
 
        UApplicationDescription *desc);
38
 
    
 
51
        UApplicationDescription *desc);
 
52
 
 
53
    /**
 
54
     * \brief Sets the application id contained in the description instance.
 
55
     * \ingroup application_support
 
56
     * \param[in] desc The application description instance, must not be NULL.
 
57
     * \param[in] id The new application id, must not be NULL.
 
58
     */
39
59
    void
40
60
    u_application_description_set_application_id(
41
 
        UApplicationDescription *desc,
42
 
        UApplicationId *id);
43
 
    
44
 
    UApplicationId* 
 
61
        UApplicationDescription *desc,
 
62
        UApplicationId *id);
 
63
 
 
64
    /**
 
65
     * \brief Queries the application id contained in the description instance.
 
66
     * \ingroup application_support
 
67
     * \returns The app id contained in the instance.
 
68
     * \param[in] desc The application description instance, must not be NULL.
 
69
     */
 
70
    UApplicationId*
45
71
    u_application_description_get_application_id(
46
 
        UApplicationDescription *desc);
47
 
    
 
72
        UApplicationDescription *desc);
 
73
 
 
74
    /**
 
75
     * \brief Sets the application lifecycle delegate
 
76
     * \ingroup application_support
 
77
     * \param[in] desc The application description instance, must not be NULL.
 
78
     * \param[in] lifecycle_delegate The new lifecycle delegate, must not be NULL.
 
79
     */
48
80
    void
49
81
    u_application_description_set_application_lifecycle_delegate(
50
 
        UApplicationDescription *desc,
51
 
        UApplicationLifecycleDelegate *lifecycle_delegate);
52
 
    
53
 
    UApplicationLifecycleDelegate* 
 
82
        UApplicationDescription *desc,
 
83
        UApplicationLifecycleDelegate *lifecycle_delegate);
 
84
 
 
85
    /**
 
86
     * \brief Queries the application lifecycle delegate
 
87
     * \ingroup application_support
 
88
     * \returns The application lifecycle delegate contained in the description instance.
 
89
     * \param[in] desc The application description instance, must not be NULL.
 
90
     */
 
91
    UApplicationLifecycleDelegate*
54
92
    u_application_description_get_application_lifecycle_delegate(
55
 
        UApplicationDescription *desc);
56
 
   
 
93
        UApplicationDescription *desc);
 
94
 
57
95
#ifdef __cplusplus
58
96
}
59
97
#endif