git.sesse.net Git - vlc/blob - doc/developer2/synopsys.txt

   1 Structure for the new vlc developer documentation
   2
   3 * Coding rules
   4         - Hungarian notation
   5         - Code indentation
   6
   7 * LibVLC, VLC, and Mozilla plugin
   8         - Libvlc structure
   9
  10 * Build system
  11         - Modules.am
  12         - bootstrap sequence
  13         - vlc-config
  14         - config.h
  15         - toolbox
  16
  17 * i18n
  18         - Gettext
  19
  20 * Modules
  21         - Calling a module
  22         - Writing a module descriptor (do not forget E_ & N_ )
  23         - The module bank
  24
  25 * Objects
  26         - vlc_object_t
  27         - Creating, deleting objects
  28         - parents and children
  29         - Refcounts
  30
  31 * CPU stuff
  32
  33 * Misc stuff
  34         - VLC_EXPORT
  35         - MODULE_NAME_is
  36         - more ?
  37
  38 * Variables, callbacks, and configuration
  39         - Variable management
  40         - adding configuration to modules
  41
  42 * Thread management
  43         - thread
  44         - mutexes
  45         - condition variables
  46
  47 * Playlist management
  48         - The playlist object
  49         - Items / Options
  50         - Playlist infos
  51
  52 * Message queue
  53
  54 * Interface modules
  55
  56 * Input layer
  57         - Access / stream
  58         - Demuxers / ES
  59         - PCR / PTS / DTS
  60         - Input, access and demux control
  61
  62 * Packetizers
  63
  64 * Decoders
  65
  66 * Vout
  67         - Subpictures
  68         - Text rendering
  69         - Filters
  70
  71 * Aout
  72         - Mixers
  73         - Filters (converters, resamplers, downmixers)
  74         - Output
  75
  76 * Sout
  77         - stream chain
  78         - packetizer
  79         - encoder
  80         - muxer
  81         - access output
  82
  83 * Porting
  84         - port specific stuff
  85
  86 * Debugging
  87         - Compile flags
  88         - Valgrind / eFence / ...