minor documentation improvements

This commit is contained in:
josh committed 2014-10-21 17:00:38 -04:00
1 parent b05eed36eb
commit d5e0475e6c
8 files changed
+74 -32

No files matched your search

+4 -2
View File
@@ -3,9 +3,11 @@ module Rscons
# Execute a command that will produce the given target based on the given
# sources.
#
# Example::
# @since 1.8.0
#
# Example:
# env.Command("docs.html", "docs.md",
# CMD => ['pandoc', '-fmarkdown', '-thtml', '-o${_TARGET}', '${_SOURCES}'])
# CMD => %w[pandoc -fmarkdown -thtml -o${_TARGET} ${_SOURCES}])
class Command < Builder
# Run the builder to produce a build target.
#
+1 -1
View File
@@ -62,7 +62,7 @@ module Rscons
# file name from a given source file name.
#
# @param target [String] The target file name.
# @param source [String, Array] The source file name(s).
# @param source [String] The source file name.
# @param env [Environment] The Environment.
#
# @return [Boolean]
+3 -1
View File
@@ -2,8 +2,10 @@ module Rscons
module Builders
# A Generic builder class whose name and operation is defined at
# instantiation.
#
# @since 1.8.0
class SimpleBuilder < Builder
# The name of this builder when registered in an environment
# @return [String] The name of this builder.
attr_reader :name
# Create a new builder with the given name and action.