Changeset 371148d3db06625f4842833f10f7deb66e3001df

Show
Ignore:
Timestamp:
07/14/03 22:36:55 (5 years ago)
Author:
Sigmund Augdal Helberg <sigmunau@videolan.org>
git-committer:
Sigmund Augdal Helberg <sigmunau@videolan.org> 1058215015 +0000
git-parent:

[d46bb4f46b37962607c51c40d6e614cd5eceb991]

git-author:
Sigmund Augdal Helberg <sigmunau@videolan.org> 1058215015 +0000
Message:

toolbox: made a --add-include that can be used by doxygen to get proper

includes in the .h files, since they are parsed out of context by
doxygen

Doxyfile: misc fixes, use ./toolbox --add-include as filter for sources.
include/vlc_common.h: doxygenized VLC_COMMON_MEMBERS

With these changes, and a slightly patched version of doxygen (which you can
get here: http://www.idi.ntnu.no/~sigmunau/doxygen-vlcpatched.tgz ) you should
be able to get some useful documentation out of the vlc sources.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • Doxyfile

    rac354f2 r371148d  
    113113# to NO the shortest path that makes the file name unique will be used. 
    114114 
    115 FULL_PATH_NAMES        = NO 
     115FULL_PATH_NAMES        = YES 
    116116 
    117117# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  
    …… 
    120120# the path. It is allowed to use relative paths in the argument list. 
    121121 
    122 STRIP_FROM_PATH        =  
     122STRIP_FROM_PATH        = . 
    123123 
    124124# The INTERNAL_DOCS tag determines if documentation  
    …… 
    173173# explict @brief command for a brief description. 
    174174 
    175 JAVADOC_AUTOBRIEF      = NO 
     175JAVADOC_AUTOBRIEF      = YES 
    176176 
    177177# If the DETAILS_AT_TOP tag is set to YES then Doxygen  
    …… 
    384384# to standard output. 
    385385 
    386 INPUT_FILTER           =  
     386INPUT_FILTER           = "./toolbox --add-include" 
    387387 
    388388# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using  
    …… 
    716716# way by setting EXPAND_ONLY_PREDEF to YES. 
    717717 
    718 MACRO_EXPANSION        = NO 
     718MACRO_EXPANSION        = YES 
    719719 
    720720# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES  
    …… 
    733733# the preprocessor. 
    734734 
    735 INCLUDE_PATH           =  
     735INCLUDE_PATH           = include include/vlc 
    736736 
    737737# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard  
    …… 
    762762# used for boiler-plate code, and will confuse the parser if not removed. 
    763763 
    764 SKIP_FUNCTION_MACROS   = YES 
     764SKIP_FUNCTION_MACROS   = NO 
    765765 
    766766#--------------------------------------------------------------------------- 

  • include/vlc_common.h

    r6350ac8 r371148d  
    44 ***************************************************************************** 
    55 * Copyright (C) 1998, 1999, 2000 VideoLAN 
    6  * $Id: vlc_common.h,v 1.67 2003/06/05 11:52:19 gbazin Exp $ 
     6 * $Id: vlc_common.h,v 1.68 2003/07/14 20:36:55 sigmunau Exp $ 
    77 * 
    88 * Authors: Samuel Hocevar <sam@via.ecp.fr> 
    …… 
    244244typedef struct subpicture_sys_t subpicture_sys_t; 
    245245typedef struct vout_synchro_t vout_synchro_t; 
     246typedef struct text_renderer_sys_t text_renderer_sys_t; 
     247typedef struct text_style_t text_style_t; 
    246248 
    247249/* Stream output */ 
    …… 
    306308/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */ 
    307309#define VLC_COMMON_MEMBERS                                                  \ 
     310/** \name VLC_COMMON_MEMBERS                                                \ 
     311 * these members are common for all vlc objects                             \ 
     312 */                                                                         \ 
     313/**@{*/                                                                     \ 
    308314    int   i_object_id;                                                      \ 
    309315    int   i_object_type;                                                    \ 
    …… 
    320326                                                                            \ 
    321327    /* Object properties */                                                 \ 
    322     volatile vlc_bool_t b_error;                    /* set by the object */ \ 
    323     volatile vlc_bool_t b_die;                     /* set by the outside */ \ 
    324     volatile vlc_bool_t b_dead;                     /* set by the object */ \ 
    325     volatile vlc_bool_t b_attached;                 /* set by the object */ \ 
     328    volatile vlc_bool_t b_error;                  /**< set by the object */ \ 
     329    volatile vlc_bool_t b_die;                   /**< set by the outside */ \ 
     330    volatile vlc_bool_t b_dead;                   /**< set by the object */ \ 
     331    volatile vlc_bool_t b_attached;               /**< set by the object */ \ 
    326332                                                                            \ 
    327333    /* Object variables */                                                  \ 
    …… 
    331337                                                                            \ 
    332338    /* Stuff related to the libvlc structure */                             \ 
    333     libvlc_t *      p_libvlc;                        /* root of all evil */ \ 
    334     vlc_t *         p_vlc;                     /* (root of all evil) - 1 */ \ 
     339    libvlc_t *      p_libvlc;                      /**< root of all evil */ \ 
     340    vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \ 
    335341                                                                            \ 
    336     volatile int    i_refcount;                           /* usage count */ \ 
    337     vlc_object_t *  p_parent;                              /* our parent */ \ 
    338     vlc_object_t ** pp_children;                         /* our children */ \ 
     342    volatile int    i_refcount;                         /**< usage count */ \ 
     343    vlc_object_t *  p_parent;                            /**< our parent */ \ 
     344    vlc_object_t ** pp_children;                       /**< our children */ \ 
    339345    volatile int    i_children;                                             \ 
    340346                                                                            \ 
    …… 
    342348    void *          p_private;                                              \ 
    343349                                                                            \ 
    344     /* Just a reminder so that people don't cast garbage */                 \ 
     350    /** Just a reminder so that people don't cast garbage */                \ 
    345351    int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \ 
     352/**@}*/                                                                     \ 
    346353 
    347354/* VLC_OBJECT: attempt at doing a clever cast */ 

  • toolbox

    r56dd78b r371148d  
    22 
    33##  toolbox for the VLC media player 
    4 ##  $Id: toolbox,v 1.40 2003/07/08 16:21:00 sam Exp $ 
     4##  $Id: toolbox,v 1.41 2003/07/14 20:36:55 sigmunau Exp $ 
    55## 
    66##  Authors: Samuel Hocevar <sam@zoy.org> 
    …… 
    8282    action=woody 
    8383    ;; 
     84  --add-include) 
     85    action=include 
     86    ;; 
    8487  --help) 
    8588    help 
    …… 
    9194esac 
    9295shift 
     96 
     97## 
     98##  Add includes to help doxygen 
     99## 
     100if test "${action}" = "include" 
     101then 
     102  case "$1" in 
     103    */vlc_common.h|*/include/vlc/*);; 
     104    */include/*.h) echo "#include <vlc_common.h>" ;; 
     105  esac 
     106  cat $1 
     107  exit 0 
     108fi 
    93109 
    94110##