Permalink
Commits on Jul 22, 2012
  1. Document a bunch of things.

    committed Jul 22, 2012
Commits on Dec 28, 2011
Commits on Dec 27, 2011
  1. Allow =head1 sections to be =include'd.

    There's a problem with this.  Included sections don't look exactly
    like ones that were hand-rolled.  They kind of need to for validation
    purposes.  Validation might need to be pushed farther down the process
    to a point after documentation is rendered but before it's returned.
    That's woefully late in the game, though.
    committed Dec 27, 2011
  2. Begin validating documentation.

    Start by ensuring the presence of SYNOPSIS and DESCRIPTION sections.
    That's a safe, easy place to begin.
    committed Dec 27, 2011
Commits on Dec 18, 2011
  1. Document more.

    committed Dec 18, 2011
  2. Fix examples for attributes whose names begin with "+".

    Pod::Plexus couldn't find overriding attributes for inclusion in
    examles.  It still doesn't flatten the override into the superclass'
    attribute definition, but that's something I want it to eventually do.
    committed Dec 18, 2011
Commits on Nov 22, 2011
  1. Fix =before and =after.

    There was a timing issue.  Calling handle_body() from the base class
    is sometimes too soon.  The AppendToBody and PrependToBody roles
    augment "doc_body"'s setter so they work after the body has been set.
    This works for now, but it feels awkward.  Hopefully there's a better
    way.
    committed Nov 22, 2011
  2. Add a --blame switch to annotate POD with the objects that created it.

    It's much easier to debug resultant POD when you know where it came
    from.
    committed Nov 22, 2011
Commits on Nov 21, 2011
  1. Document more.

    committed Nov 21, 2011
  2. Extend Pod::Plexus syntax to handle head1 paragraphs.

    Pod::Plexus is starting to absorb POD syntax in order to expand
    templates in POD-only content.  I've found that I want [% m.package %]
    and such to work in documentation at large.  Probably =include and
    =example, too.
    committed Nov 21, 2011
  3. Improve error reporting.

    Required serious refactoring of how errors are reported in the first
    place.
    committed Nov 20, 2011
Commits on Nov 20, 2011
  1. Start marking documentation passes.

    I need a way to see which module documentation hasn't been edited
    lately.  Otherwise some modules are liable to fall into disrepair.
    committed Nov 20, 2011
  2. Add the roles that define how to handle section bodies.

    Proof of concetp for =inherit consuming documentation from roles.
    committed Nov 20, 2011
  3. Add support for documentation composed from roles.

    Documentation defined in roles is propagated into classes.
    Practically speaking, roles can define "=boierplate" sections that
    consumers can "=include".  The appropriate role's boilerplate will
    customize the consumer's documentation.
    committed Nov 20, 2011
  4. Enable more complex Template toolkit behavior in boilerplates.

    Boilerplates can introspect the classes whose documentation into which
    they're included.  Then they can alter their content to better fit the
    classes' behaviors.  See Pod::Plexus::Matter for an example.
    committed Nov 20, 2011
Commits on Nov 19, 2011
  1. Add more documentation.

    Regrettably, Pod::Plexus doesn't seem to be making the documentation
    process much more joyful.  It is giving me some peace of mind that my
    docs are less likely to become obsolete as things change, and that's
    worth the price of admission so far.
    committed Nov 19, 2011
Commits on Nov 18, 2011
  1. Inherit or automatically generate attribute documentation.

    Documentation for attributes is inherited from base classes if
    necessary.  When there's absolutely no documentation for an attribute,
    Pod::Plexus will generate a "not documented yet" stub.  There's a TODO
    comment to extend that by introspecting the attribute.
    committed Nov 18, 2011
Commits on Nov 17, 2011
  1. Flatten documentation of inherited methods.

    When a subclass inherits a method but doesn't document it, the base
    class' documentation will be inherited too.
    
    Methods without documentation entirely are given a "not documented
    yet" entry.  An irritating little reminder that they exist.  A social
    hack to prompt someone to do something about it.
    committed Nov 17, 2011
Commits on Nov 16, 2011
  1. Add variable expansion.

    POD can be inherited, included and otherwise moved around without
    breaking naming.
    
    [% d %] evaulates to the main distribution object.  Eventually the
    distribution's main package name will be available through
    [% d.package %].
    
    [% m %] is the current Pod::Plexus::Module object.  [% m.package %]
    accesses the mdoule's package name attribute.  All other documented
    accessors are available, too.
    
    [% s %] is the current section being rendered.  [% s.name %] is the
    current section's name, which may be a method or attribute name in the
    cases of =method and =attribute, respectively.  All other accessors
    are also available.
    committed Nov 16, 2011
Commits on Nov 14, 2011
  1. Begin redocumenting in earnest.

    committed Nov 14, 2011
  2. Refactor examples so that subclasses handle rendering.

    Avoid dispatching to rendering code in a multi-condition if/elseif
    statement.  Delegate to subclasses of Pod::Plexus::Matter::element
    instead.
    committed Nov 14, 2011
Commits on Nov 13, 2011
  1. Add MANIFEST.SKIP to eliminate cruft from distributions. It's really

    a hard link from ~/.manifest.skip.
    committed Nov 13, 2011
  2. Rename Docs to Matter.

    committed Nov 13, 2011