[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

source documentation



As mentioned in our last two meetings, Mash needs a lot documentation
including:  file abstracts, procedure headers, class documentation,
tutorials, sample code, etc.

As discussed last meeting, I have slapped our new copyright/license
headers on every source code file.  There is a place at the top (marked
FIXME) for a brief description of what the file does.  Here are the
directories that people "volunteered" to take and write short
descriptions (1 or 2 lines is good enough) for each file.

If you create new source code files, make sure you copy the
copyright/license header and edit it for your new file.  Templates are
provided in mash-1/license.c and mash-1/license.tcl.

Thanks,
Lloyd

PS:  This list is shorter than the one in the meeting because some old
empty directories were pruned.
----------

Erik
    apps/amx
    apps/vcc3
    mash-1/dc
    mash-1/vd
    mash-1/tcl/dc
    mash-1/tcl/dp
    mash-1/tcl/vd

Matt
    mash-1/tcl/nsdr

Peter
    mash-1/sim/hm
    mash-1/tcl/as
    mash-1/tcl/hm
    mash-1/tcl/hmsp

Tim
    mash-1/tcl/agw
    mash-1/tcl/rtpgw
    mash-1/tcl/rtpgw_ui
    mash-1/tcl/tgw
    mash-1/tcl/vat
    mash-1/tcl/vgw
    mash-1/tcl/vic

unassigned
    mash-1/archive
    mash-1/atobj
    mash-1/audio
    mash-1/bitmaps
    mash-1/codec
    mash-1/codec/audio
    mash-1/codec/jpeg
    mash-1/codec/ldct
    mash-1/codec/p64
    mash-1/codec/video
    mash-1/compat
    mash-1/conf
    mash-1/fca
    mash-1/grabber
    mash-1/mb
    mash-1/mbv2
    mash-1/mc
    mash-1/misc
    mash-1/mplug
    mash-1/net
    mash-1/ps
    mash-1/psvp
    mash-1/render
    mash-1/rtp
    mash-1/rtsp
    mash-1/srm
    mash-1/srmv2
    mash-1/tcl/applications/aries
    mash-1/tcl/applications/avswitch-client
    mash-1/tcl/applications/avswitch-server
    mash-1/tcl/applications/camera-client
    mash-1/tcl/applications/camera-server
    mash-1/tcl/applications/collaborator
    mash-1/tcl/applications/collaborator/images
    mash-1/tcl/applications/lhm
    mash-1/tcl/applications/mars
    mash-1/tcl/applications/mashcast
    mash-1/tcl/applications/mbv2
    mash-1/tcl/applications/mbv2/images
    mash-1/tcl/applications/newscast
    mash-1/tcl/applications/pathfinder
    mash-1/tcl/applications/pathfinder/html
    mash-1/tcl/applications/pathfinder/html/images
    mash-1/tcl/applications/player
    mash-1/tcl/applications/powerswitch-client
    mash-1/tcl/applications/powerswitch-server
    mash-1/tcl/applications/recorder
    mash-1/tcl/applications/room-manager
    mash-1/tcl/applications/rover
    mash-1/tcl/applications/stockcast
    mash-1/tcl/applications/uc
    mash-1/tcl/applications/webpoller
    mash-1/tcl/archive
    mash-1/tcl/arms
    mash-1/tcl/atobj
    mash-1/tcl/cache
    mash-1/tcl/casa
    mash-1/tcl/caster
    mash-1/tcl/common
    mash-1/tcl/cues
    mash-1/tcl/demo
    mash-1/tcl/fca
    mash-1/tcl/handoffClient
    mash-1/tcl/handoffServer
    mash-1/tcl/hvic
    mash-1/tcl/mat
    mash-1/tcl/mb
    mash-1/tcl/mbgw
    mash-1/tcl/mc
    mash-1/tcl/mcdemo
    mash-1/tcl/mega
    mash-1/tcl/megafor
    mash-1/tcl/megatest
    mash-1/tcl/mgamon
    mash-1/tcl/mplug
    mash-1/tcl/mps
    mash-1/tcl/msp
    mash-1/tcl/mui
    mash-1/tcl/net
    mash-1/tcl/psvp
    mash-1/tcl/reflector
    mash-1/tcl/rtsp
    mash-1/tcl/rvic
    mash-1/tcl/rvic-client
    mash-1/tcl/scuba
    mash-1/tcl/sdfor
    mash-1/tcl/sdgw
    mash-1/tcl/serial
    mash-1/tcl/setup
    mash-1/tcl/srm
    mash-1/tcl/srmv2
    mash-1/tcl/srmv2-cache
    mash-1/tcl/ssac
    mash-1/tcl/tgmb
    mash-1/tcl/ui_tools
    mash-1/tcl/video
    mash-1/tgmb
    mash-1/utils
    mash-1/video