Changeset 43a3035ffdaf90ae4303b55b27802205521f5982

Show
Ignore:
Timestamp:
04/01/08 00:02:12 (3 months ago)
Author:
Faustino Osuna <enrique.osuna@gmail.com>
git-committer:
Faustino Osuna <enrique.osuna@gmail.com> 1207000932 +0100
git-parent:

[79b9d34ee355a0934cae8451a283f74e2c87dc5e]

git-author:
Faustino Osuna <enrique.osuna@gmail.com> 1207000932 +0100
Message:

VLCKit.framework: Documentation updates, whitespace cleanup.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • projects/macosx/framework/Headers/Internal/VLCEventManager.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCEventManager.h: VLC.framework VLCEventManager header 
     2 * VLCEventManager.h: VLCKit.framework VLCEventManager header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 

  • projects/macosx/framework/Headers/Internal/VLCLibVLCBridging.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2 * VLCLibVLCbridging.h: VLC.framework VLCLibVLCBridging (Private) header 
     2* VLCLibVLCbridging.h: VLCKit.framework VLCLibVLCBridging (Private) header 
    33***************************************************************************** 
    44* Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    2727#import "VLCStreamOutput.h" 
    2828 
     29/* Utility functions */ 
     30/** 
     31 * \function catch_execption( ex ) 
     32 * Utility function that catches a LibVLC generated exception by throwing a Cocoa based NSException.   
     33 * \param ex LibVLC exception returned by LibVLC internal functions. 
     34 */ 
     35#define catch_exception( ex ) __catch_exception( (void *)(ex), __FUNCTION__, __FILE__, __LINE__ ) 
     36extern void __catch_exception( void * e, const char * function, const char * file, int line_number ); 
     37 
    2938/** 
    3039 * Bridges functionality between libvlc and VLCMediaList implementation. 
    3140 */ 
    32  
    33 /* 
    34  * Utility function 
    35  */ 
    36  
    37 #define catch_exception( ex ) __catch_exception( (void *)(ex), __FUNCTION__, __FILE__, __LINE__ ) 
    38 extern void __catch_exception( void * e, const char * function, const char * file, int line_number ); 
    39  
    40 /* 
    41  * @interface VLC(class) (LibVLCBridging) 
    42  */ 
    43  
    4441@interface VLCMediaList (LibVLCBridging) 
    4542/* Factories */ 
    …… 
    104101 */ 
    105102- (void)setLength:(VLCTime *)value; 
    106  
    107  
    108103@end 
    109104 
    …… 
    178173@end 
    179174 
     175/** 
     176 * TODO: Documentation 
     177 */ 
    180178@interface VLCStreamOutput (LibVLCBridge) 
    181179- (NSString *)representedLibVLCOptions; 

  • projects/macosx/framework/Headers/Internal/VLCVideoCommon.h

    rdbddc5a r43a3035  
    11/***************************************************************************** 
    2  * VLCVideoCommon.h: VLC.framework VLCVideoCommon header 
     2 * VLCVideoCommon.h: VLCKit.framework VLCVideoCommon header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    2525#import <QuartzCore/QuartzCore.h> 
    2626 
     27/** 
     28 * TODO: Documentation 
     29 */ 
    2730@interface VLCVideoLayoutManager : NSObject 
    2831{ 
    …… 
    3033    BOOL  fillScreenEntirely; 
    3134} 
     35 
     36/* Factories */ 
     37+ (id)layoutManager; 
     38 
     39/* Properties */ 
    3240@property BOOL  fillScreenEntirely; 
    3341@property CGSize originalVideoSize; 
    34  
    35 + (id)layoutManager; 
    36  
    3742@end 

  • projects/macosx/framework/Headers/Public/VLCAudio.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCAudio.h: VLC.framework VLCAudio header 
     2 * VLCAudio.h: VLCKit.framework VLCAudio header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Faustino E. Osuna 

  • projects/macosx/framework/Headers/Public/VLCKit.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLC.h: VLC.framework main header 
     2 * VLCKit.h: VLCKit.framework main header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    2323 *****************************************************************************/ 
    2424 
    25 #ifndef VLC_FRAMEWORK_VLC_H 
    26 #define VLC_FRAMEWORK_VLC_H 
     25/** 
     26 * TODO: Framework Documetnation 
     27 */ 
    2728 
    2829#import <VLCKit/VLCLibrary.h> 
    …… 
    4445@class VLCTime; 
    4546@class VLCVideoView; 
    46  
    47 #endif /* VLC_FRAMEWORK_VLC_H */ 

  • projects/macosx/framework/Headers/Public/VLCLibrary.h

    r39bd598 r43a3035  
    11/***************************************************************************** 
    2  * VLCLibrary.h: VLC.framework VLCLibrary implementation 
     2 * VLCLibrary.h: VLCKit.framework VLCLibrary implementation 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    2828#import "VLCMedia.h" 
    2929 
    30  
     30// FIXME: Hide from public header 
    3131extern void * CreateSharedLibraryOnStartup( void ) __attribute__((constructor)); 
    3232extern void * DestroySharedLibraryAtExit( void ) __attribute__((destructor)); 
    …… 
    3535 
    3636/** 
    37  * VLCLibrary object. 
    38  * TODO: Documentation VLCLibrary 
     37 * The VLCLibrary is the base library of the VLCKit.framework.  This object provides a shared instance that exposes the 
     38 * internal functionalities of libvlc and libvlc-control. The VLCLibrary object is instantiated automatically when 
     39 * VLCKit.framework is loaded into memory.  Also, it is automatically destroyed when the VLCKit.framework is unloaded 
     40 * from memory. 
     41 * 
     42 * Currently, the framework does not support multiple instances of VLCLibrary.  Furthermore, you cannot destroy any 
     43 * instiantiation of VLCLibrary, as previously noted, this is done automatically by the dynamic link loader. 
    3944 */ 
    4045@interface VLCLibrary : NSObject  
    …… 
    4651/* Factories */ 
    4752/** 
    48  * TODO: Documentation + [VLCLibrary sharedLibrary] 
     53 * Returns the library's shared instance. 
     54 * \return The library's shared instance. 
    4955 */ 
    5056+ (VLCLibrary *)sharedLibrary; 
    …… 
    5258/* Properties */ 
    5359/** 
    54  * TODO: Documentation VLCLibrary.audio 
     60 * Returns the library's audio object.  This object is used to manipulate the global audio properities of the shared 
     61 * library. 
     62 * \return The library's shared audio instance. 
    5563 */ 
    5664@property (readonly) VLCAudio * audio; 

  • projects/macosx/framework/Headers/Public/VLCMedia.h

    r4a19225 r43a3035  
    11/***************************************************************************** 
    2  * VLCMedia.h: VLC.framework VLCMedia header 
     2 * VLCMedia.h: VLCKit.framework VLCMedia header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    101101/** 
    102102 * Defines files and streams as a managed object.  Each media object can be  
    103  * administered seperately.  VLCMediaPlayer or VLCMediaControl must be used  
     103 * administered seperately.  VLCMediaPlayer or VLCMediaList must be used  
    104104 * to execute the appropriate playback functions. 
    105105 * \see VLCMediaPlayer 
    106  * \see VLCMediaControl 
     106 * \see VLCMediaList 
    107107 */ 
    108108@interface VLCMedia : NSObject 
    109109{ 
    110110    void *                p_md;              //< Internal media descriptor instance 
    111     NSURL *               url;               //< URL for this media resource 
     111    NSURL *               url;               //< URL (MRL) for this media resource 
    112112    VLCMediaList *        subitems;          //< Sub list of items 
    113     VLCTime *             length;            //< Duration of the media 
     113    VLCTime *             length;            //< Cached duration of the media 
    114114    NSMutableDictionary * metaDictionary;    //< Meta data storage 
    115115    id                    delegate;          //< Delegate object 
    116116    BOOL                  artFetched;        //< Value used to determine of the artwork has been preparsed 
    117     VLCMediaState         state; 
     117    VLCMediaState         state;             //< Current state of the media 
    118118} 
    119119 
    120 /* Object Factories */ 
     120/* Factories */ 
    121121/** 
    122122 * Manufactures a new VLCMedia object using the URL specified. 
    123123 * \param anURL URL to media to be accessed. 
    124  * \return A new VLCMedia object, only if there were no errors.  This object  
    125  * will be automatically released. 
     124 * \return A new VLCMedia object, only if there were no errors.  This object will be automatically released. 
    126125 * \see initWithMediaURL 
    127126 */ 
    …… 
    131130 * Manufactures a new VLCMedia object using the path specified. 
    132131 * \param aPath Path to the media to be accessed. 
    133  * \return A new VLCMedia object, only if there were no errors.  This object  
    134  * will be automatically released. 
     132 * \return A new VLCMedia object, only if there were no errors.  This object will be automatically released. 
    135133 * \see initWithPath 
    136134 */ 

  • projects/macosx/framework/Headers/Public/VLCMediaDiscoverer.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCMediaDiscoverer.h: VLC.framework VLCMediaDiscoverer header 
     2 * VLCMediaDiscoverer.h: VLCKit.framework VLCMediaDiscoverer header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 

  • projects/macosx/framework/Headers/Public/VLCMediaLibrary.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCMediaDiscoverer.h: VLC.framework VLCMediaDiscoverer header 
     2 * VLCMediaDiscoverer.h: VLCKit.framework VLCMediaDiscoverer header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    3636    VLCMediaList * allMedia; 
    3737} 
    38 /* Singleton */ 
     38/* Factories */ 
    3939+ (id)sharedMediaLibrary; 
    4040 

  • projects/macosx/framework/Headers/Public/VLCMediaList.h

    rdbddc5a r43a3035  
    11/***************************************************************************** 
    2  * VLCMediaList.h: VLC.framework VLCMediaList header 
     2 * VLCMediaList.h: VLCKit.framework VLCMediaList header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 

  • projects/macosx/framework/Headers/Public/VLCMediaListAspect.h

    rdbddc5a r43a3035  
    11/***************************************************************************** 
    2  * VLCMediaLisAspect.h: VLC.framework VLCMediaLisAspect header 
     2 * VLCMediaLisAspect.h: VLCKit.framework VLCMediaLisAspect header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 

  • projects/macosx/framework/Headers/Public/VLCMediaPlayer.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCMediaPlayer.h: VLC.framework VLCMediaPlayer header 
     2 * VLCMediaPlayer.h: VLCKit.framework VLCMediaPlayer header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    3535 
    3636/** 
    37  * TODO: Documentation VLCMediaPlayerState 
     37 * VLCMediaPlayerState describes the state of the media player. 
    3838 */ 
    3939typedef enum VLCMediaPlayerState 
    …… 
    4949 
    5050/** 
    51  * TODO: Documentation extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState) 
     51 * Returns the name of the player state as a string. 
     52 * \param state The player state. 
     53 * \return A string containing the name of state. If state is not a valid state, returns nil. 
    5254 */ 
    5355extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); 
    …… 
    5961@protocol VLCMediaPlayerDelegate 
    6062/** 
    61  * TODO: Documentation - [VLCMediaPlayerDelegate ] 
     63 * Sent by the default notification center whenever the player's time has changed. 
     64 * \details Discussion The value of aNotification is always an VLCMediaPlayerTimeChanged notification. You can retrieve  
     65 * the VLCMediaPlayer object in question by sending object to aNotification. 
    6266 */ 
    6367- (void)mediaPlayerTimeChanged:(NSNotification *)aNotification; 
    6468 
    6569/** 
    66  * TODO: Documentation - [VLCMediaPlayerDelegate ] 
     70 * Sent by the default notification center whenever the player's state has changed. 
     71 * \details Discussion The value of aNotification is always an VLCMediaPlayerStateChanged notification. You can retrieve  
     72 * the VLCMediaPlayer object in question by sending object to aNotification. 
    6773 */ 
    6874- (void)mediaPlayerStateChanged:(NSNotification *)aNotification; 
    …… 
    7379{ 
    7480    id delegate;                        //< Object delegate 
    75  
    7681    void * instance;                    //  Internal 
    7782    VLCMedia * media;                   //< Current media being played 
    78     VLCTime * cachedTime; 
    79     VLCMediaPlayerState cachedState; 
    80     float position; 
     83    VLCTime * cachedTime;               //< Cached time of the media being played 
     84    VLCMediaPlayerState cachedState;    //< Cached state of the media being played 
     85    float position;                     //< The position of the media being played 
    8186} 
    8287 

  • projects/macosx/framework/Headers/Public/VLCTime.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCTime.h: VLC.framework VLCTime header 
     2 * VLCTime.h: VLCKit.framework VLCTime header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 

  • projects/macosx/framework/Headers/Public/VLCVideoLayer.h

    rdbddc5a r43a3035  
    11/***************************************************************************** 
    2  * VLCVideoLayer.h: VLC.framework VLCVideoLayer header 
     2 * VLCVideoLayer.h: VLCKit.framework VLCVideoLayer header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    2929    BOOL hasVideo; 
    3030} 
     31 
     32/* Properties */ 
    3133@property (readonly) BOOL hasVideo; 
    3234@property BOOL fillScreen; 

  • projects/macosx/framework/Headers/Public/VLCVideoView.h

    rb3372f1 r43a3035  
    11/***************************************************************************** 
    2  * VLCVideoView.h: VLC.framework VLCVideoView header 
     2 * VLCVideoView.h: VLCKit.framework VLCVideoView header 
    33 ***************************************************************************** 
    44 * Copyright (C) 2007 Pierre d'Herbemont 
    …… 
    3535} 
    3636 
     37/* Properties */ 
    3738@property (assign) id delegate; 
    3839@property (copy) NSColor *backColor;