haa cleanup

[sdlhildon] / sdlhaa / src / SDL_haa.h

diff --git a/sdlhaa/src/SDL_haa.h b/sdlhaa/src/SDL_haa.h
index db9c5d2..7cc6217 100644 (file)
--- a/sdlhaa/src/SDL_haa.h
+++ b/sdlhaa/src/SDL_haa.h
@@ -60,7 +60,9 @@ typedef enum HAA_Actor_Pending {
        HAA_PENDING_EVERYTHING          = 0xFFU
 } HAA_Actor_Pending;
 
+/** A Hildon Animation Actor. */
 typedef struct HAA_Actor {
+       /** The associated SDL surface; you can render to it. */
        SDL_Surface * surface;
        Uint8 pending;
        Uint8 visible, opacity, gravity;
@@ -91,6 +93,7 @@ extern DECLSPEC int SDLCALL HAA_FilterEvent(const SDL_Event *event);
 
 /** Call after calling SDL_SetVideoMode() if you have any actors created
   * to ensure they're visible in the new window.
+  * If you have no actors, it does nothing.
   * @return 0 if everything went OK.
   */
 extern DECLSPEC int SDLCALL HAA_SetVideoMode(void);
@@ -106,6 +109,7 @@ extern DECLSPEC int SDLCALL HAA_SetVideoMode(void);
 extern DECLSPEC HAA_Actor* SDLCALL HAA_CreateActor(Uint32 flags,
        int width, int height, int bitsPerPixel);
 
+/** Frees an animation actor and associated surface. */
 extern DECLSPEC void SDLCALL HAA_FreeActor(HAA_Actor* actor);
 
 /** Flushes any pending position, scale, orientation, etc. changes. */