autoEdit 2 Documentation
1.0.13
1.0.13
  • Introduction
  • Overview
    • Intro
      • Development approach
      • from 1.0.5 to 1.0.6
    • Architecture Overview
      • Lo fi Design Sketches
      • High fidelity sketches in HTML
    • Support the project
    • documentation section template
    • Build / Deployment
      • Deployment/build for Mac OS X
      • Deployment / Build for Linux
      • Deployment / Build for Windows
      • Travis CI continuous build
        • previous travis setup
  • R&D Doc
    • About R&D doc section
    • Transcription & Media Processing
      • Transcription json
      • Transcriber
        • audio to video
        • STT sdks
          • IBM Watson STT
          • Gentle STT
          • Pocketsphinx
      • Video preview conversion
      • Read metadata
    • Hypertranscript
    • Selections, Annotations, Papercuts
      • Selections
      • Annotations
      • Tags
    • Paper-edit
      • Paper-edit json
      • search-filter
      • drag-and-drop
      • Preview Paper-edit video
    • Export
      • EDL export
      • XML export
      • mp4 export
  • Appendix
    • Dev configuration
    • Current db setup
    • EDL Format
    • Reusable components
    • Prerequisites
    • Testing
    • Updating automated documentation
    • ffmpeg and ffprobe in electron
    • Adding STT services
  • Appendix - Data structures
    • IBM Watson json specs
    • Gentle Json transcription specs
    • Pocketsphinx results
    • autoEdit transcription Json
  • QA List
    • QA Intro
  • Adobe Panel
    • autoEdit Adobe CEP Panel dev setup
      • Adobe Extensions HostList codes
    • autoEdit Adobe CEP Panel integration overview
    • Jsx functions for Adobe CEP autoEdit adobe Panel
    • Packaging and distributing Adobe CEP Extensions
      • Packaging signing Adobe CEP Panel in details
      • Submit to Adobe
  • Project Page
    • Build project page
    • Build/update demo front end page
  • Roadmap
    • Improvements
    • Roadmap
      • Paper-editing Roadmap
      • Extra Features Roadmap
      • Future Roadmap
        • Live video editing
        • Social Media Export
        • Translate transcriptions
        • Web app
          • Multi-user collaboration
        • Searchable Editable Archive
        • NLP insights
        • Slack/Chat bot integration
        • Interactive dev tool
        • Phone mms integration with twillio
        • B-roll computational photography
Powered by GitBook
On this page
  • Updating documentation with Docco
  • Docco config
  • Updating documentation with JSDoc
  • Jsdoc config
  • Updating developer's tutorial
  1. Appendix

Updating automated documentation

PreviousTestingNextffmpeg and ffprobe in electron

Last updated 6 years ago

Documentation links

Note that for now the index.html nwjs starter page is left out of the automatically generated docs.

Updating documentation with Docco

Using for documentation inspired by blog post. In conjunction with json doc.

install docco globally

npm install docco -g

to re-generate documentation run from root of app

npm run docco

this puts documentation in /docs/docco_docs folder.

Docco config

The setup for this is done in package.json scripts where the folders/files to consider for documentations and destination folder(-o) are specified.

"docco": "docco -o ./docs/docco_docs --title 'autoEdit 2 Documentation' ./*.js ./frontEnd/*.js ./frontEnd/date_now/*.js ./frontEnd/edl_composer/*.js ./frontEnd/srt/*.js ./frontEnd/js/*.js ./frontEnd/js/models/*.js ./frontEnd/js/views/*.js ./frontEnd/js/collections/*.js ./interactive_transcription_generator/*.js ./interactive_transcription_generator/**/*.js",

Updating documentation with JSDoc

To get up and running with updating the documentation install jsdoc locally

npm install jsdoc -save

to re-generate documentation run from root of app

npm run jsdoc

Jsdoc config

This executes the script in package.json, and places the documentation inside of /docs/jsdoc_docs.

   "jsdoc": "./node_modules/.bin/jsdoc *.js  -c ./docs/jdocs_conf/conf.json"

See /docs/jdocs_conf/conf.json for the config options,that specify which files to include, exclude etc..

Updating developer's tutorial

To add or update a tutorial in the developer documentation tutorials, go to /docs/_posts/tutorial where you can find the markdown files.

when writing code comments.

Edit config file as explain in {:target="_blank"}

This is because you need to edit the config file in the module at ./node_modules/jsdoc/config.json. And this part of the information is at .

in documentation. In this project this is used for topics that might deserve a standalone explanation .

Docco style code documentation
JSdoc style code documentation
docco
this
see here for jsodc tags to use
blog post
usejsdoc.org
Jsdoc allows to link to tutorial
such as the one on the EDL format