scan the functions for those lacking documentation - Githubissues

mmagnuski / eegDb

eegDb is an egglab plugin that eases up managing preprocessing routines. It allows to create project databases for reproducible eeg preprocessing with eeglab.

MIT License

3 stars 3 forks source link

scan the functions for those lacking documentation #10

Open mmagnuski opened 10 years ago

mmagnuski commented 10 years ago

Use NOHELPINFO tag-word to mark these functions

mmagnuski commented 10 years ago

Files lacking documentation

Currently these files are lacking documentation:

[ ] 'ICAw_checkfields.m'
[ ] 'ICAw_copyrec.m'
[ ] 'ICAw_dipfit.m'
[ ] 'ICAw_sorter.m'
[ ] 'eeg_getrej.m'
[ ] 'ICAw_ep_proc_GUI.m'
[ ] 'ICAw_gui_choose_chan.m'
[ ] 'ICAw_gui_epoch.m'
[ ] 'ICAw_gui_upd_txt.m'
[ ] 'ICAw_gui_upd_txt2.m'
[ ] 'gui_chooselist.m'
[ ] 'gui_editbox.m'
[ ] 'gui_multiedit.m'
[ ] 'selcol_GUI.m'
[ ] 'ICAw_applyrej.m'
[ ] 'ICAw_newrejtype.m'
[ ] 'ICAw_nonrej.m'
[ ] 'ICAw_rejICAw2EEG.m'
[ ] 'ICAw_rejTMP.m'
[ ] 'ICAw_rem_marks.m'
[ ] 'ICAw_scanrejtypes.m'
[ ] 'ICAw_addversion.m'
[ ] 'ICAw_bringversion.m'
[ ] 'ICAw_mainversion.m'
[ ] 'ICAw_vers_compare.m'
[ ] 'ICAw_scan4patterns.m'
[ ] 'ICAw_tag_search.m'
[ ] 'check_dipfit_status.m'
[ ] 'comment_search.m'
[ ] 'listTaggedFuncs.m'

mmagnuski commented 10 years ago

Thesre is now a howto on listing files by tag keyword like FIXHELPINFO.

mmagnuski commented 9 years ago

[ ] create an early sketch of build_doc.py or build_doc.m that scans docstrings of all the .m functions and reports FIXHELPINFO, NOHELPINFO etc.