josh/rscons
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add @since tags for new methods

Browse Source
This commit is contained in:
Josh Holtrop 2017-05-12 21:07:25 -04:00
parent 3e4897c04b
commit 7a31039e35
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/rscons/builder.rb
View File

@ -68,6 +68,8 @@ module Rscons
# needed later in the build, it can be stored in the return value from this # needed later in the build, it can be stored in the return value from this
# method, which will be passed to the {#run} method. # method, which will be passed to the {#run} method.
# #
# @since 1.10.0
#
# @param options [Hash] # @param options [Hash]
# Options. # Options.
# @option options [String] :target # @option options [String] :target
@ -94,6 +96,7 @@ module Rscons
# the method's arity. # the method's arity.
# #
# @overload run(target, sources, cache, env, vars) # @overload run(target, sources, cache, env, vars)
#
# @param target [String] # @param target [String]
# Target file name. # Target file name.
# @param sources [Array<String>] # @param sources [Array<String>]
@ -104,7 +107,11 @@ module Rscons
# The Environment executing the builder. # The Environment executing the builder.
# @param vars [Hash,VarSet] # @param vars [Hash,VarSet]
# Extra construction variables. # Extra construction variables.
#
# @overload run(options) # @overload run(options)
#
# @since 1.10.0
#
# @param options [Hash] Run options. # @param options [Hash] Run options.
# @option options [String] :target # @option options [String] :target
# Target file name. # Target file name.

2
lib/rscons/environment.rb
View File

@ -472,6 +472,8 @@ module Rscons
# This method is used internally by Rscons builders. It should be called # This method is used internally by Rscons builders. It should be called
# from the builder's #setup method. # from the builder's #setup method.
# #
# @since 1.10.0
#
# @param sources [Array<String>] # @param sources [Array<String>]
# List of source file(s) to build. # List of source file(s) to build.
# @param suffixes [Array<String>] # @param suffixes [Array<String>]