kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
puppet-strings/lib/puppetx/puppetlabs/strings/yard/plugin.rb

17 lines
653 B
Ruby
Raw Normal View History

Fix plugin loading from YARD This patch fixes an error related to `Puppet::Util` being missing when YARD loads `puppetx/yardoc/yard/plugin`.
2014-05-28 07:06:04 +00:00
require 'puppet'
(PDOC-3) Use require instead of require_relative Prior to this commit, the puppet strings project was using require_relative to include other classes and modules. Due to some ambiguity and the fact that the strings project shares some naming conventions with YARD, the use of require_relative sometimes made it unclear what was being included and where it was coming from. Now require is being used and although this requires the full path, it makes it very clear where things are coming from.
2014-09-23 18:27:27 +00:00
require 'puppetx/puppetlabs/strings/yard/monkey_patches'
require 'puppetx/puppetlabs/strings/yard/parser'
require 'puppetx/puppetlabs/strings/yard/handlers'
Add YARD plugin A simple file that registers the parser and handlers with YARD.
2014-05-23 06:46:07 +00:00
YARD::Parser::SourceParser.register_parser_type(:puppet,
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
Puppetx::PuppetLabs::Strings::YARD::PuppetParser,
Add YARD plugin A simple file that registers the parser and handlers with YARD.
2014-05-23 06:46:07 +00:00
['pp'])
YARD::Handlers::Processor.register_handler_namespace(:puppet,
(PDOC-3) Add puppetlabs directory In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
2014-09-16 16:07:59 +00:00
Puppetx::PuppetLabs::Strings::YARD::Handlers)
Move Puppet classes into a custom namespace Instead of documenting Puppet classes using `ClassObject`, use a custom subclass of `NamespaceObject`. This is done because Puppet classes are not Ruby classes and will have components that don't fit into the model offered by `ClassObject`. This commit also adds a couple of monkey patches to integrate the new `:hostclass` into YARD tooling and the beginnings of some custom templating.
2014-05-26 05:59:46 +00:00
# FIXME: Might not be the best idea to have the template code on the Ruby
# LOAD_PATH as the contents of this directory really aren't library code.
YARD::Templates::Engine.register_template_path(File.join(
File.dirname(__FILE__),
'templates'))