Forum OpenACS Development: Re: Package Documentation: How can we tell if a package is fully documented?

Collapse
2: Re: Package Documentation: How can we tell if a package is fully documented? (response to 1)
Posted by Roberto Mello on 01/16/03 11:38 PM
These are the items a package HAS to have in my opinion:

- User Documentation explaining what the package does and how it works.

- Developer documentation that talks about how the package is implemented and its design.

- API is well documented through the use of ad_proc.

- SQL is documented with comments throughout the files.

-Roberto

Collapse
3: Re: Package Documentation: How can we tell if a package is fully documented? (response to 2)
Posted by Bart Teeuwisse on 01/16/03 11:48 PM
Roberto wrote: API is well documented through the use of ad_proc.

By using documentation tags:

  • @param
  • @see
  • @author
  • @creation-date
  • @return
  • @error

/Bart