Skip to content

Commit

Permalink
adjusted line wrapping in usage message to avoid ugly wrapped lines w…
Browse files Browse the repository at this point in the history
…hen running with wscript.exe
  • Loading branch information
ansgarwiechers committed Jun 28, 2020
1 parent 6341b89 commit 5a382f7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 23 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,23 @@ Usage
VBSdoc.vbs /?

/? Print this help.
/a Generate documentation for all elements (public and private).
Without this option, documentation is generated for public
elements only.
/d Enable debug messages. (you really don't want this)
/e Process files with the given extension (default: vbs).
/h Create CHM_FILE in addition to normal HTML output. (requires
HTML Help Workshop)
/i Read input files from SOURCE. Can be either a file or a
directory. (required)
/l Generate localized output (available: de,en,pt; default: en).
/a Generate documentation for all elements (public
and private). Without this option, documentation
is generated for public elements only.
/d Enable debug messages. (you really don't want
this)
/e Process files with the given extension.
(default: vbs).
/h Create CHM_FILE in addition to normal HTML
output. (requires HTML Help Workshop)
/i Read input files from SOURCE. Can be either a file
or a directory. (required)
/l Generate localized output (available: de,en,pt;
default: en).
/o Create output files in DOC_DIR. (required)
/p Use NAME as the project name.
/q Don't print warnings. Ignored if debug messages are enabled.

/q Don't print warnings. Ignored if debug messages
are enabled.

Output Format
=============
Expand Down
26 changes: 15 additions & 11 deletions VBSdoc.vbs
Original file line number Diff line number Diff line change
Expand Up @@ -2825,19 +2825,23 @@ Private Sub PrintUsage(exitCode)
& vbTab & vbTab & "/i:SOURCE /o:DOC_DIR" & vbNewLine _
& vbTab & WScript.ScriptName & " /?" & vbNewLine & vbNewLine _
& vbTab & "/?" & vbTab & "Print this help." & vbNewLine _
& vbTab & "/a" & vbTab & "Generate documentation for all elements (public and private)." & vbNewLine _
& vbTab & vbTab & "Without this option, documentation is generated for public" & vbNewLine _
& vbTab & vbTab & "elements only." & vbNewLine _
& vbTab & "/d" & vbTab & "Enable debug messages. (you really don't want this)" & vbNewLine _
& vbTab & "/e" & vbTab & "Process files with the given extension (default: " & DefaultExtension & ")." & vbNewLine _
& vbTab & "/h" & vbTab & "Create CHM_FILE in addition to normal HTML output. (requires" & vbNewLine _
& vbTab & vbTab & "HTML Help Workshop)" & vbNewLine _
& vbTab & "/i" & vbTab & "Read input files from SOURCE. Can be either a file or a" & vbNewLine _
& vbTab & vbTab & "directory. (required)" & vbNewLine _
& vbTab & "/l" & vbTab & "Generate localized output (available: " & Join(Sort(localize.Keys), ",") & "; default: " & DefaultLanguage & ")." & vbNewLine _
& vbTab & "/a" & vbTab & "Generate documentation for all elements (public" & vbNewLine _
& vbTab & vbTab & "and private). Without this option, documentation" & vbNewLine _
& vbTab & vbTab & "is generated for public elements only." & vbNewLine _
& vbTab & "/d" & vbTab & "Enable debug messages. (you really don't want" & vbNewLine _
& vbTab & vbTab & "this)" & vbNewLine _
& vbTab & "/e" & vbTab & "Process files with the given extension." & vbNewLine _
& vbTab & vbTab & "(default: " & DefaultExtension & ")." & vbNewLine _
& vbTab & "/h" & vbTab & "Create CHM_FILE in addition to normal HTML" & vbNewLine _
& vbTab & vbTab & "output. (requires HTML Help Workshop)" & vbNewLine _
& vbTab & "/i" & vbTab & "Read input files from SOURCE. Can be either a file" & vbNewLine _
& vbTab & vbTab & "or a directory. (required)" & vbNewLine _
& vbTab & "/l" & vbTab & "Generate localized output (available: " & Join(Sort(localize.Keys), ",") & ";" & vbNewLine _
& vbTab & vbTab & "default: " & DefaultLanguage & ")." & vbNewLine _
& vbTab & "/o" & vbTab & "Create output files in DOC_DIR. (required)" & vbNewLine _
& vbTab & "/p" & vbTab & "Use NAME as the project name." & vbNewLine _
& vbTab & "/q" & vbTab & "Don't print warnings. Ignored if debug messages are enabled."
& vbTab & "/q" & vbTab & "Don't print warnings. Ignored if debug messages" & vbNewLine _
& vbTab & vbTab & "are enabled."
WScript.Quit exitCode
End Sub

Expand Down

0 comments on commit 5a382f7

Please sign in to comment.