puppet-strings/lib/puppetx/strings.rb

require 'puppetx'

# Nothing to see here except forward declarations.
module Puppetx::Strings
  # This submodule contains bits that interface with the YARD plugin system.
  module YARD
  end

  # This submodule contains bits that operate on the Pops module produced by
  # the Future parser.
  module Pops
  end
end
Re-architect around a YARD parser Start building a YARD parser. Parsing and comment extraction has been moved out of the yardoc face and into the new `Puppetx::Yardoc::YARD::PuppetParser` class. The old `Commentor` class from the Util module has been renamed to `Puppetx::Yardoc::Pops::YARDTransformer`. `puppet yardoc` is still capable of extracting docstrings for node, class and type definitions from a single manifest file. 2014-05-23 04:02:35 +00:00			`require 'puppetx'`

			`# Nothing to see here except forward declarations.`
(PDOC-3) Rename face to strings instead of yardoc Since we don't want the name of the tool to reflect the fact that it is using yard internally (this is an implementation detail), rename the face to `strings`. Now when one wishes to generate documentation, `puppet strings` will be used rather than `puppet yardoc`. 2014-09-11 00:07:33 +00:00			`module Puppetx::Strings`
Re-architect around a YARD parser Start building a YARD parser. Parsing and comment extraction has been moved out of the yardoc face and into the new `Puppetx::Yardoc::YARD::PuppetParser` class. The old `Commentor` class from the Util module has been renamed to `Puppetx::Yardoc::Pops::YARDTransformer`. `puppet yardoc` is still capable of extracting docstrings for node, class and type definitions from a single manifest file. 2014-05-23 04:02:35 +00:00			`# This submodule contains bits that interface with the YARD plugin system.`
			`module YARD`
			`end`

			`# This submodule contains bits that operate on the Pops module produced by`
			`# the Future parser.`
			`module Pops`
			`end`
			`end`