Permalink
Browse files

Added placeholder accepting settings indication to --help output.

  • Loading branch information...
1 parent 3511deb commit 9331a35989fc1baeaa39708eccc591aa5e1b3f1f @tomaz committed Dec 17, 2010
Showing with 21 additions and 13 deletions.
  1. +21 −13 Application/GBAppledocApplication.m
@@ -562,26 +562,34 @@ - (void)printHelp {
PRINT_USAGE(@" ", kGBArgWarnOnUndocumentedMember, @"<bool>", @"Warn on undocumented member");
ddprintf(@"\n");
ddprintf(@"DOCUMENTATION SET INFO\n");
- PRINT_USAGE(@" ", kGBArgDocSetBundleIdentifier, @"<string>", @"DocSet bundle identifier");
- PRINT_USAGE(@" ", kGBArgDocSetBundleName, @"<string>", @"DocSet bundle name");
- PRINT_USAGE(@" ", kGBArgDocSetDescription, @"<string>", @"DocSet description");
- PRINT_USAGE(@" ", kGBArgDocSetCopyrightMessage, @"<string>", @"DocSet copyright message");
- PRINT_USAGE(@" ", kGBArgDocSetFeedName, @"<string>", @"DocSet feed name");
- PRINT_USAGE(@" ", kGBArgDocSetFeedURL, @"<string>", @"DocSet feed URL");
- PRINT_USAGE(@" ", kGBArgDocSetFallbackURL, @"<string>", @"DocSet fallback URL");
- PRINT_USAGE(@" ", kGBArgDocSetPublisherIdentifier, @"<string>", @"DocSet publisher identifier");
- PRINT_USAGE(@" ", kGBArgDocSetPublisherName, @"<string>", @"DocSet publisher name");
- PRINT_USAGE(@" ", kGBArgDocSetMinimumXcodeVersion, @"<string>", @"DocSet min. Xcode version");
- PRINT_USAGE(@" ", kGBArgDocSetPlatformFamily, @"<string>", @"DocSet platform familiy");
- PRINT_USAGE(@" ", kGBArgDocSetCertificateIssuer, @"<string>", @"DocSet certificate issuer");
- PRINT_USAGE(@" ", kGBArgDocSetCertificateSigner, @"<string>", @"DocSet certificate signer");
+ PRINT_USAGE(@" ", kGBArgDocSetBundleIdentifier, @"<string>", @"[*] DocSet bundle identifier");
+ PRINT_USAGE(@" ", kGBArgDocSetBundleName, @"<string>", @"[*] DocSet bundle name");
+ PRINT_USAGE(@" ", kGBArgDocSetDescription, @"<string>", @"[*] DocSet description");
+ PRINT_USAGE(@" ", kGBArgDocSetCopyrightMessage, @"<string>", @"[*] DocSet copyright message");
+ PRINT_USAGE(@" ", kGBArgDocSetFeedName, @"<string>", @"[*] DocSet feed name");
+ PRINT_USAGE(@" ", kGBArgDocSetFeedURL, @"<string>", @"[*] DocSet feed URL");
+ PRINT_USAGE(@" ", kGBArgDocSetFallbackURL, @"<string>", @"[*] DocSet fallback URL");
+ PRINT_USAGE(@" ", kGBArgDocSetPublisherIdentifier, @"<string>", @"[*] DocSet publisher identifier");
+ PRINT_USAGE(@" ", kGBArgDocSetPublisherName, @"<string>", @"[*] DocSet publisher name");
+ PRINT_USAGE(@" ", kGBArgDocSetMinimumXcodeVersion, @"<string>", @"[*] DocSet min. Xcode version");
+ PRINT_USAGE(@" ", kGBArgDocSetPlatformFamily, @"<string>", @"[*] DocSet platform familiy");
+ PRINT_USAGE(@" ", kGBArgDocSetCertificateIssuer, @"<string>", @"[*] DocSet certificate issuer");
+ PRINT_USAGE(@" ", kGBArgDocSetCertificateSigner, @"<string>", @"[*] DocSet certificate signer");
ddprintf(@"\n");
ddprintf(@"MISCELLANEOUS\n");
PRINT_USAGE(@" ", kGBArgLogFormat, @"<number>", @"Log format [0-3]");
PRINT_USAGE(@" ", kGBArgVerbose, @"<number>", @"Log verbosity level [0-6]");
PRINT_USAGE(@" ", kGBArgVersion, @"", @"Display version and exit");
PRINT_USAGE(@" ", kGBArgHelp, @"", @"Display this help and exit");
ddprintf(@"\n");
+ ddprintf(@"[*] indicates parameters accepting placeholder strings:\n");
+ ddprintf(@"- $PROJECT replaced with --project-name\n");
+ ddprintf(@"- $VERSION replaced with --project-version\n");
+ ddprintf(@"- $COMPANY replaced with --project-company\n");
+ ddprintf(@"- $COMPANYID replaced with --company-id\n");
+ ddprintf(@"- $YEAR replaced with current year (format yyyy)\n");
+ ddprintf(@"- $UPDATEDATE replaced with current date (format yyyy-MM-dd)\n");
+ ddprintf(@"\n");
ddprintf(@"appledoc uses the following open source components, fully or partially:\n");
ddprintf(@"\n");
ddprintf(@"- DDCli by Dave Dribin\n");

0 comments on commit 9331a35

Please sign in to comment.