Firefox/Projects/TabCandy/Work: Difference between revisions

Firefox/Projects/TabCandy/Work (view source)

334 bytes added , 29 June 2010

68

edits

@@ Line 46: / Line 46: @@
 = Code Documentation =
-We're using [http://www.naturaldocs.org/documenting.html Natural Docs]. There's a shell script (only tested on Mac) that runs Natural Docs on our code and converts the comments in the JavaScript to HTML docs: [http://hg.mozilla.org/labs/tabcandy/file/tip/makedocs.sh makedocs.sh].
+You can find the [http://hg.mozilla.org/labs/tabcandy/raw-file/tip/content/doc/index.html documentation here].
-It'll generate a folder, naturaldocs-data, that'll be ignored by hg; you should ignore it too... it's just cache for the script.
+We're using [http://www.naturaldocs.org/documenting.html Natural Docs]. There's a shell script (only tested on Mac) that runs Natural Docs on our code and converts the comments in the JavaScript to HTML docs. It'll generate a folder, naturaldocs-data, that'll be ignored by hg; you should ignore it too... it's just cache for the script.
+Even though the TabCandy code is now in the tabcandy-central branch, we're still keeping the documentation in the old tabcandy branch. The docs script, [http://hg.mozilla.org/labs/tabcandy/file/tip/tcc-docs.sh tcc-docs.sh], assumes your tabcandy-central folder is next to your tabcandy folder.