Permalink
Browse files

Updated read me with cmd line usage.

  • Loading branch information...
1 parent f1c8665 commit 645e93cf586de7a8225cc77c74fa44275b6bbbdc @tomaz committed Mar 26, 2012
Showing with 11 additions and 1 deletion.
  1. +10 −0 Readme.markdown
  2. +1 −1 appledoc/main.m
View
@@ -27,6 +27,16 @@ This is experimental branch. It's focus is on [bringing appledoc to next level](
Current focus: **source code parser**
+Command line usage for various tasks:
+
+- Testing source code parser:
+
+ appledoc -p MyProject -v 1.0 -c MyCompany -u com.mycompany -v 4 --log-format=0 --log-common=0 --log-parsing=1 <path(s)>
+
+ This will only log parser tokens so you can test if it "understands" everything from your source files.
+
+- Use `appledoc --help` for help, or add `--print-settings` switch to see all the values used on the current run session (for simpler debugging).
+
For questions and feedback on experimental branch, use [Google groups forum](https://groups.google.com/forum/#!forum/appledoc).
appledoc requires Xcode 4 or greater for compiling and OS X 10.7 for running!
View
@@ -21,7 +21,7 @@ static void registerOptionDefinitions(GBOptionsHelper *options) {
{ 'p', GBOptions.projectName, @"Project name", GBValueRequired },
{ 'v', GBOptions.projectVersion, @"Project version", GBValueRequired },
{ 'c', GBOptions.companyName, @"Company name", GBValueRequired },
- { 0, GBOptions.companyIdentifier, @"Company UTI (i.e. reverse DNS name)", GBValueRequired },
+ { 'u', GBOptions.companyIdentifier, @"Company UTI (i.e. reverse DNS name)", GBValueRequired },
{ 0, nil, @"PATHS", GBOptionSeparator },
{ 0, GBOptions.inputPaths, @"[a] Array of input paths for global and project settings", GBValueRequired|GBOptionNoCmdLine|GBOptionInvisible },

0 comments on commit 645e93c

Please sign in to comment.