kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add docstrings to yardoc face

This commit is contained in:
Charlie Sharpsteen 2014-05-31 23:24:27 -07:00
parent 353b48bb1a
commit 043fb34721
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/puppet/face/yardoc.rb
View File

@ -1,10 +1,14 @@
require 'puppet/face' require 'puppet/face'
Puppet::Face.define(:yardoc, '0.0.1') do Puppet::Face.define(:yardoc, '0.0.1') do
summary "Generate Puppet documentation with YARD."
action(:yardoc) do action(:yardoc) do
default default
summary "Generate module documentation."
arguments "[manifest_file.pp ...]"
when_invoked do |*args| when_invoked do |*args|
unless Puppet.features.yard? unless Puppet.features.yard?
raise RuntimeError, "The 'yard' gem must be installed in order to use this face." raise RuntimeError, "The 'yard' gem must be installed in order to use this face."