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

View File

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