Tags:
create new tag
, view all tags
Excerpted from some other topic...

does anyone want to help docco this? (John is otherwise occupied) -- SvenDowideit - 24 Jun 2004

I can do this if there is a sample documentation that I could follow... -- ThomasWeigert - 24 Jun 2004

How to Write Documentation

Well, this is not quite the definitive guide yet, but here are two pointers to examples:

Document user functionality

The best example I think is something MattWilkie did in UsingFormsForSettings for example in a dotted div section. Basically though, if you can put (on this topic) any information the a user will need to use this feature, that would be a great help.

-- SvenDowideit - 27 Jun 2004

Document API and handlers

There are a bunch of examples of code documentation done in the extractable documentation style in the UI module. Pick any .pm in there and copy the style of the POD blocks, retaining all newlines! If you can add a block describing the handler in FuncDotPm as well then that would be a big boon to plugins authors.

-- CrawfordCurrie - 28 Jun 2004

Topic revision: r1 - 2004-07-03 - ThomasWeigert
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.