{"id":1451,"date":"2018-01-19T19:22:51","date_gmt":"2018-01-19T19:22:51","guid":{"rendered":"http:\/\/goofy-trucks.flywheelsites.com\/how-to-document-your-php-classes-page-5\/"},"modified":"2018-01-19T19:24:48","modified_gmt":"2018-01-19T19:24:48","slug":"how-to-document-your-php-classes-page-5","status":"publish","type":"post","link":"https:\/\/phpbuilder.com\/how-to-document-your-php-classes-page-5\/","title":{"rendered":"How To Document Your PHP Classes Page 5"},"content":{"rendered":"
\n
\n
By Stefano Locati<\/div>\n
on August 25, 2000<\/div>\n<\/p><\/div>\n
\n

How To Modify The Script For PHP<\/h2>\n
\nThe original HeaderDoc script from Apple is meant for C or C++ headers, so it has to be slightly
\nmodified to use it with PHP. If you’re not interested about details you can just
\ndownload<\/a> it and
\nskip to the next section.<\/div>\n
\nThe only thing to modify in the sources is in the main perl file and it’s made to make the script accept
\n.php and .php3 extensions.<\/div>\n
\n
\n$ diff headerDoc2HTML.pl \/usr\/local\/bin\/headerdoc2html\n195c195\n<     ($rootFileName = $filename) =~ s\/.(h|i)$\/\/;\n---\n>     ($rootFileName = $filename) =~ s\/.(h|i|php|php3)$\/\/;\n<\/pre>\n<\/div>\n
Running The Script<\/h2>\n
\nAfter having installed the script, supposing that your classes are in the classes subdirectory and
\nthat you want to put the generated documentation in the docs directory, you should issue this command:<\/div>\n
\n
\nheaderdoc2html -o docs classes\/*.php\n<\/pre>\n<\/div>\n
\nUnfortunately if there are multiple PHP files, this script has the bad habit to split those files in different
\ndirectories, making navigation among classes’ documentation more difficoult. Moreover since the original script
\nwas written for C\/C++ header files that are just declarations of classes and functions and have no definitions
\nfor them, it outputs all the code following the function name until a ;<\/code> is found, so tipically
\nthe first line of code.<\/div>\n
\nBut before you get desperate after all the effort reading till now, relax because I wrote a simple script to
\nsolve both these problems.<\/div>\n
\n
\ncat classes\/*.php | sed 's\/ *{\/;#{\/g' | tr \"#\" \"n\" > docs\/all.php\nheaderdoc2html -o docs docs\/all.php\nrm docs\/all.php\n<\/pre>\n<\/div>\n
\nIf you’re wondering why I use the tr utility here instead of doing all the job with sed, the reason
\nis that sed 3.02 that is still used on RedHat 6.2 doesn’t handle newlines. The new version sed 3.02a
\nwould be needed instead. If you’re curious see the
\nSED FAQ<\/a>.<\/div>\n
\n Good luck with your documentation effort!<\/div>\n
\nStefano Locati<\/a><\/div>\n
\n–Stefano\n<\/div>\n<\/div>\n
<\/p>\n
\n
\u00ab Previous Page<\/a><\/div>\n
1<\/a> <\/div>\n
| <\/div>\n
2<\/a> <\/div>\n
| <\/div>\n
3<\/a> <\/div>\n
| <\/div>\n
4<\/a> <\/div>\n
| <\/div>\n
5<\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
By Stefano Locati on August 25, 2000 How To Modify The Script For PHP The original HeaderDoc script from Apple is meant for C or C++ headers, so it has to be slightly modified to use it with PHP. If you’re not interested about details you can just download it… <\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-1451","post","type-post","status-publish","format-standard","hentry","category-tutorials"],"_links":{"self":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1451","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/comments?post=1451"}],"version-history":[{"count":1,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1451\/revisions"}],"predecessor-version":[{"id":3307,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/posts\/1451\/revisions\/3307"}],"wp:attachment":[{"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/media?parent=1451"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/categories?post=1451"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/phpbuilder.com\/wp-json\/wp\/v2\/tags?post=1451"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}