Getting started with PHPDocumentor
Posted: Fri Jul 22, 2005 3:45 pm
I'm trying to start using phpDocumentor on my project now. I've installed the package and run it over my current code (without any special tags) just to see what it can find on its own as they describe.
It works rather well, I'll go back through as I debug/test code to add the important/useful tags. However I'm a little confused as to how to deal with the "legal cruft". E.G. all my files have a header:
after converting my previous comment style to phpDocument style. Now my File isn't really needed. Don't know why I ever had it, so I'll ditch that. Author can be replaced with @author, or just remeoved entirely (following XP guidelines.). Ditto for the changelog (that's what CVS (or other versioning system) is for.
However how to deal with the copyright assignment, GPL notice code. This needs to be at the top of every file, but it seems to get jumbled badly by the phpDocumentor. Any suggestions?
It works rather well, I'll go back through as I debug/test code to add the important/useful tags. However I'm a little confused as to how to deal with the "legal cruft". E.G. all my files have a header:
Code: Select all
/**
* This file is part of CompInaBox.
* Copyright 2001-2005. Eric D. Nielsen, All rights reserverd
* CompInaBox is available for license under the GPL, see
* the COPYING file in the root directory of the install for
* the full terms of the GPL.
*
* File: CompetitorListFormatter.inc
* Author: Eric D. Nielsen
* Change Log: 7/22/05 -- created -- edn
*/However how to deal with the copyright assignment, GPL notice code. This needs to be at the top of every file, but it seems to get jumbled badly by the phpDocumentor. Any suggestions?