Skip to content

Commit

Permalink
[sarldoc] Fixing errors in the help text.
Browse files Browse the repository at this point in the history
Signed-off-by: Stéphane Galland <galland@arakhne.org>
  • Loading branch information
gallandarakhneorg committed May 28, 2020
1 parent f2a263e commit 6204bfe
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
Expand Up @@ -22,6 +22,7 @@
package io.sarl.sarldoc.modules.configs;

import static io.bootique.BQCoreModule.extend;
import static io.sarl.sarldoc.configs.SarldocConfig.DOC_OUTPUT_DIRECTORY_FILE;
import static io.sarl.sarldoc.configs.SarldocConfig.DOC_OUTPUT_DIRECTORY_NAME;
import static io.sarl.sarldoc.configs.SarldocConfig.ENABLE_AUTHOR_TAG_NAME;
import static io.sarl.sarldoc.configs.SarldocConfig.ENABLE_DEPRECATED_TAG_NAME;
Expand Down Expand Up @@ -91,7 +92,7 @@ protected void configure() {
VariableDecls.extend(binder()).declareVar(DOC_OUTPUT_DIRECTORY_NAME);
extend(binder()).addOption(OptionMetadata.builder(
Constants.DOCUMENTATION_OUTPUT_DIRECTORY_OPTION,
Messages.SarldocConfigModule_1)
MessageFormat.format(Messages.SarldocConfigModule_1, DOC_OUTPUT_DIRECTORY_FILE))
.valueRequired(Messages.SarldocConfigModule_4)
.build())
.mapConfigPath(Constants.DOCUMENTATION_OUTPUT_DIRECTORY_OPTION, DOC_OUTPUT_DIRECTORY_NAME);
Expand Down
@@ -1,7 +1,7 @@
SarldocConfigModule_0 = Specify the path to the executable of Javadoc. If it is not specified, the value will be inferred \
from the current installation of the Java environment.
SarldocConfigModule_1 = Specify the output folder into which the generated HTML documentation will be copied. If it is not \
specified, the default sarldoc folder is used.
specified, the default folder is : {0}.
SarldocConfigModule_2 = Specify the title of the documentation.
SarldocConfigModule_3 = file
SarldocConfigModule_4 = directory
Expand Down
Expand Up @@ -5,9 +5,9 @@ SarldocApplicationModule_2 = Sarldoc is a documentation generator for the SARL l
format from SARL source code. The HTML format is used for adding the convenience of being able to hyperlink related documents \
together.\nTo pass source code to sarldoc, you have to provide the names of the folders in which the \
SARL code files are located.\nSource code file names must have .sarl suffixes, Java class file names must have .class \
suffixes.\nBy default, the SARL compiler puts each Java source file in the directory {0}. You can specify a separate destination \
suffixes.\nBy default, the SARL compiler puts each Java source file in the directory {0}. You can specify a different destination \
directory with the {1} option.\nBy default, the SARL compiler puts each Java class file in the directory {2}. You can specify \
a separate destination directory with the {3} option.\nBy default, the generated HTML pages in the directory {4}. You can specify \
a separate destination directory with the {5} option.
a different destination directory with the {3} option.\nBy default, the generated HTML pages in the directory {4}. You can specify \
a different destination directory with the {5} option.
SarldocApplicationModuleProvider_0 = The name and description of the application.
SarldocDynamicClassLoaderModuleProvider_0 = The dynamic class loader for sarldoc.

0 comments on commit 6204bfe

Please sign in to comment.