Apigen generates nearly empty documentation

111 views
Skip to first unread message

sswg...@gmail.com

unread,
Jul 13, 2014, 12:39:03 PM7/13/14
to api...@googlegroups.com
Hello,

I am trying to make Apigen work on my PHP project in Netbeans 8.0 and my after clicking "Generate documentation" my output is as follows:


"E:\wamp\bin\php\php5.5.12\apigen.bat" "--source" "E:\wamp\www" "--destination" "E:\test" "--title" "test" "--charset" "UTF-8" "--access-levels" "public,protected,private" "--internal" "yes" "--php" "yes" "--tree" "yes" "--deprecated" "yes" "--todo" "yes" "--download" "yes" "--source-code" "yes" "--colors" "yes" "--update-check" "no"
ApiGen 2.8.0
------------
Scanning E:\wamp\www
[===============================================================>] 100.00%   7MB
Found 2 classes, 0 constants, 1 functions and other 1 used PHP internal classes
Documentation for 2 classes, 0 constants, 1 functions and other 1 used PHP internal classes will be generated
Using template config file E:\wamp\bin\php\php5.5.12\templates\default\config.neon
Wiping out destination directory
Generating to directory E:\test
[===============================================================>] 100.00%  10MB
Done. Total time: 9 sec, used: 13 MB RAM
Done.


It found 2 classes while there are dozens of classes in the project (particularly .inc files). How is this possible? How can I make it generate full documentation?
I've tried several things and Googled a lot, but could not find any answer.
All classes are documented with at least:

/**
 * Description
 * 
 * @author author
 * @version 1.0
 * @package com.example
 */

I am a total newb concerning this subject... hope someone can point me in right direction.

ma...@littlelightmedia.com

unread,
Jul 28, 2014, 11:43:50 AM7/28/14
to api...@googlegroups.com, sswg...@gmail.com
Hello, I'm a complete newb here too.  I've setup NetBeans 8 with Apigen 2.8.0 like you and think you might have to add .inc to the list of files that Apigen parses.  Under NetBean's preferences, add a parameter in your apigen script such as ( yourpath/apigen --extensions "php,inc" )

I'm having trouble getting documentation to generate for Page-Level info ... like @author.  Let me know if you have any tips for none-object oriented notes.

Good luck!
Reply all
Reply to author
Forward
0 new messages