Table of Contents - puppet-strings-0.99.0 Documentation
Pages
- CHANGELOG
- COMMITTERS
- CONTRIBUTING
- LICENSE
-
README
- Puppet Strings
- Requirements
- Installing the YARD Gem
- Installing the redcarpet Gem (Puppet Enterprise 3.8 only)
- Installing Puppet Strings
- Running Puppet Strings
- YARD Options
- Documenting Puppet Extensions
- Puppet Classes / Defined Types
- Resource Types
- Providers
- Functions
- Puppet 3.x Functions
- Puppet 4.x Functions
- Puppet Language Functions
- Additional Resources
- Rake Tasks
- Developing and Contributing
- Running Specs
- Support
Classes and Modules
- Object
- Puppet
- Puppet::Application
- Puppet::Application::Strings
- PuppetStrings
- PuppetStrings::Json
- PuppetStrings::Tasks
- PuppetStrings::Yard
- PuppetStrings::Yard::CodeObjects
- PuppetStrings::Yard::CodeObjects::Base
- PuppetStrings::Yard::CodeObjects::Class
- PuppetStrings::Yard::CodeObjects::Classes
- PuppetStrings::Yard::CodeObjects::DefinedType
- PuppetStrings::Yard::CodeObjects::DefinedTypes
- PuppetStrings::Yard::CodeObjects::Function
- PuppetStrings::Yard::CodeObjects::Functions
- PuppetStrings::Yard::CodeObjects::Group
- PuppetStrings::Yard::CodeObjects::Provider
- PuppetStrings::Yard::CodeObjects::Providers
- PuppetStrings::Yard::CodeObjects::Type
- PuppetStrings::Yard::CodeObjects::Type::Feature
- PuppetStrings::Yard::CodeObjects::Type::Parameter
- PuppetStrings::Yard::CodeObjects::Type::Property
- PuppetStrings::Yard::CodeObjects::Types
- PuppetStrings::Yard::Handlers
- PuppetStrings::Yard::Handlers::Puppet
- PuppetStrings::Yard::Handlers::Puppet::Base
- PuppetStrings::Yard::Handlers::Puppet::ClassHandler
- PuppetStrings::Yard::Handlers::Puppet::DefinedTypeHandler
- PuppetStrings::Yard::Handlers::Puppet::FunctionHandler
- PuppetStrings::Yard::Handlers::Ruby
- PuppetStrings::Yard::Handlers::Ruby::Base
- PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- PuppetStrings::Yard::Handlers::Ruby::ProviderHandler
- PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- PuppetStrings::Yard::Parsers
- PuppetStrings::Yard::Parsers::Puppet
- PuppetStrings::Yard::Parsers::Puppet::ClassStatement
- PuppetStrings::Yard::Parsers::Puppet::DefinedTypeStatement
- PuppetStrings::Yard::Parsers::Puppet::FunctionStatement
- PuppetStrings::Yard::Parsers::Puppet::ParameterizedStatement
- PuppetStrings::Yard::Parsers::Puppet::ParameterizedStatement::Parameter
- PuppetStrings::Yard::Parsers::Puppet::Parser
- PuppetStrings::Yard::Parsers::Puppet::Statement
- PuppetStrings::Yard::Tags
- PuppetStrings::Yard::Tags::OverloadTag
- PuppetStrings::Yard::Tags::ParameterDirective
- PuppetStrings::Yard::Tags::PropertyDirective
- YARD
- YARD::CLI
- YARD::CLI::Stats
- YARD::CLI::Yardoc
- YARD::Parser
- YARD::Parser::Ruby
- YARD::Tags
Methods
- ::docstring_to_hash — PuppetStrings::Json
- ::generate — PuppetStrings
- ::handles? — PuppetStrings::Yard::Handlers::Puppet::Base
- ::instance — PuppetStrings::Yard::CodeObjects::Classes
- ::instance — PuppetStrings::Yard::CodeObjects::DefinedTypes
- ::instance — PuppetStrings::Yard::CodeObjects::Functions
- ::instance — PuppetStrings::Yard::CodeObjects::Group
- ::instance — PuppetStrings::Yard::CodeObjects::Providers
- ::instance — PuppetStrings::Yard::CodeObjects::Types
- ::new — PuppetStrings::Yard::CodeObjects::Base
- ::new — PuppetStrings::Yard::CodeObjects::Class
- ::new — PuppetStrings::Yard::CodeObjects::DefinedType
- ::new — PuppetStrings::Yard::CodeObjects::Function
- ::new — PuppetStrings::Yard::CodeObjects::Provider
- ::new — PuppetStrings::Yard::CodeObjects::Type
- ::new — PuppetStrings::Yard::CodeObjects::Type::Parameter
- ::new — PuppetStrings::Yard::CodeObjects::Type::Feature
- ::new — PuppetStrings::Yard::Parsers::Puppet::Parser
- ::new — PuppetStrings::Yard::Parsers::Puppet::Statement
- ::new — PuppetStrings::Yard::Parsers::Puppet::ParameterizedStatement
- ::new — PuppetStrings::Yard::Parsers::Puppet::ParameterizedStatement::Parameter
- ::new — PuppetStrings::Yard::Parsers::Puppet::ClassStatement
- ::new — PuppetStrings::Yard::Parsers::Puppet::DefinedTypeStatement
- ::new — PuppetStrings::Yard::Parsers::Puppet::FunctionStatement
- ::new — PuppetStrings::Yard::Tags::OverloadTag
- ::register! — PuppetStrings::Yard::Tags::ParameterDirective
- ::register! — PuppetStrings::Yard::Tags::PropertyDirective
- ::render — PuppetStrings::Json
- ::run_server — PuppetStrings
- ::setup! — PuppetStrings::Yard
- #add — PuppetStrings::Yard::CodeObjects::Type::Parameter
- #add_command — PuppetStrings::Yard::CodeObjects::Provider
- #add_confine — PuppetStrings::Yard::CodeObjects::Provider
- #add_default — PuppetStrings::Yard::CodeObjects::Provider
- #add_feature — PuppetStrings::Yard::CodeObjects::Provider
- #add_feature — PuppetStrings::Yard::CodeObjects::Type
- #add_method_overload — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #add_overload_tag — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #add_param_tag — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #add_parameter — PuppetStrings::Yard::CodeObjects::Type
- #add_property — PuppetStrings::Yard::CodeObjects::Type
- #add_return_tag — PuppetStrings::Yard::Handlers::Puppet::FunctionHandler
- #add_return_tag — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #add_tag — PuppetStrings::Yard::Tags::OverloadTag
- #add_tags — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #alias — PuppetStrings::Yard::CodeObjects::Type::Parameter
- #all_objects — YARD::CLI::Yardoc
- #box_info — Object
- #build_generate_options — Object
- #call — PuppetStrings::Yard::Tags::ParameterDirective
- #call — PuppetStrings::Yard::Tags::PropertyDirective
- #check_required_features — Object
- #classes — Object
- #commands — Object
- #comments — PuppetStrings::Yard::Parsers::Puppet::Statement
- #comments_hash_flag — PuppetStrings::Yard::Parsers::Puppet::Statement
- #confines — Object
- #create_menu_lists — Object
- #create_parameter — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #create_property — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #defaults — Object
- #defined_types — Object
- #enumerator — PuppetStrings::Yard::Parsers::Puppet::Parser
- #extract_docstring — PuppetStrings::Yard::Parsers::Puppet::Statement
- #find_docstring — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #first_line — PuppetStrings::Yard::Parsers::Puppet::Statement
- #function_type — PuppetStrings::Yard::CodeObjects::Function
- #functions — Object
- #generate_class_list — Object
- #generate_method_list — Object
- #generate_puppet_class_list — Object
- #generate_puppet_defined_type_list — Object
- #generate_puppet_function_list — Object
- #generate_puppet_provider_list — Object
- #generate_puppet_type_list — Object
- #get_3x_docstring — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #get_name — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #get_name — PuppetStrings::Yard::Handlers::Ruby::ProviderHandler
- #get_name — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #has_tag? — PuppetStrings::Yard::Tags::OverloadTag
- #init — Object
- #layout — Object
- #menu_lists — Object
- #method_missing — PuppetStrings::Yard::Tags::OverloadTag
- #name — PuppetStrings::Yard::CodeObjects::Classes
- #name — PuppetStrings::Yard::CodeObjects::DefinedTypes
- #name — PuppetStrings::Yard::CodeObjects::Functions
- #name — PuppetStrings::Yard::CodeObjects::Providers
- #name — PuppetStrings::Yard::CodeObjects::Types
- #node_as_string — PuppetStrings::Yard::Handlers::Ruby::Base
- #object= — PuppetStrings::Yard::Tags::OverloadTag
- #objects — Object
- #objects_by_letter — Object
- #output — YARD::CLI::Stats
- #overload — Object
- #param — Object
- #parameters — Object
- #parse — PuppetStrings::Yard::Parsers::Puppet::Parser
- #path — PuppetStrings::Yard::CodeObjects::Group
- #populate_provider_data — PuppetStrings::Yard::Handlers::Ruby::ProviderHandler
- #populate_type_data — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #properties — Object
- #providers — Object
- #register_provider_docstring — PuppetStrings::Yard::Handlers::Ruby::ProviderHandler
- #respond_to_missing? — PuppetStrings::Yard::Tags::OverloadTag
- #set_default_namevar — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #set_parameter_types — PuppetStrings::Yard::Handlers::Puppet::Base
- #set_values — PuppetStrings::Yard::Handlers::Ruby::TypeHandler
- #show — PuppetStrings::Yard::Parsers::Puppet::Statement
- #signature — PuppetStrings::Yard::CodeObjects::Function
- #signature — PuppetStrings::Yard::Tags::OverloadTag
- #source — PuppetStrings::Yard::CodeObjects::Class
- #source — PuppetStrings::Yard::CodeObjects::DefinedType
- #stats_for_puppet_classes — YARD::CLI::Stats
- #stats_for_puppet_defined_types — YARD::CLI::Stats
- #stats_for_puppet_functions — YARD::CLI::Stats
- #stats_for_puppet_providers — YARD::CLI::Stats
- #stats_for_puppet_types — YARD::CLI::Stats
- #tag — PuppetStrings::Yard::Tags::OverloadTag
- #tags — PuppetStrings::Yard::Tags::OverloadTag
- #to_hash — PuppetStrings::Yard::CodeObjects::Class
- #to_hash — PuppetStrings::Yard::CodeObjects::DefinedType
- #to_hash — PuppetStrings::Yard::CodeObjects::Function
- #to_hash — PuppetStrings::Yard::CodeObjects::Provider
- #to_hash — PuppetStrings::Yard::CodeObjects::Type
- #to_hash — PuppetStrings::Yard::CodeObjects::Type::Parameter
- #to_hash — PuppetStrings::Yard::CodeObjects::Type::Feature
- #to_hash — PuppetStrings::Yard::Tags::OverloadTag
- #to_puppet_literal — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler
- #transform_Factory — PuppetStrings::Yard::Parsers::Puppet::Parser
- #transform_FunctionDefinition — PuppetStrings::Yard::Parsers::Puppet::Parser
- #transform_HostClassDefinition — PuppetStrings::Yard::Parsers::Puppet::Parser
- #transform_Object — PuppetStrings::Yard::Parsers::Puppet::Parser
- #transform_Program — PuppetStrings::Yard::Parsers::Puppet::Parser
- #transform_ResourceTypeDefinition — PuppetStrings::Yard::Parsers::Puppet::Parser
- #type — PuppetStrings::Yard::CodeObjects::Class
- #type — PuppetStrings::Yard::CodeObjects::DefinedType
- #type — PuppetStrings::Yard::CodeObjects::Function
- #type — PuppetStrings::Yard::CodeObjects::Group
- #type — PuppetStrings::Yard::CodeObjects::Provider
- #type — PuppetStrings::Yard::CodeObjects::Type
- #type — PuppetStrings::Yard::Tags::OverloadTag
- #type_statistics_all — YARD::CLI::Stats
- #types — Object
- #validate_overload — PuppetStrings::Yard::Handlers::Ruby::FunctionHandler