vBdoc - Source code documentation in the admincp [no longer supported]

[Brad]

This modification is no longer supported! -

Jelsoft has released their own source code documentation, thus I will no longer be working on this project or making new html files from the source code.

See this thread (https://vborg.vbsupport.ru/showthread.php?t=100094) to get the link to the offical API documentation.



vBdocs is an add-on for developers that places the source code documentation right in the admincp. The documentation is generated with the latest version of phpdoc (www.phpdoc.org/) and picks up on just about everything that was included in the source code documentation wise.

There are still known errors in the documentation, you can read the error log at /docs/vbsource/errors.html.

If you would like you can generate your own doc files, the instructions on how to do so are at phpdoc's website.

Installation instructions included in the zip file, same as the upgrade instructions. :)

[Chris M]

Nice one Brad ;)

Satan

[Dream]

sorry kinda confused, is this a phpdoc compilation of beta 4? are you going to update it in each new version

[bigcurt]

alright brad, maybe im dumb but..I would love something like that for 3.0.X..does it list the source php files in your admin cp? Is that what it does.

[merk]

alright brad, maybe im dumb but..I would love something like that for 3.0.X..does it list the source php files in your admin cp? Is that what it does.

No. phpDoc is a comment syntax for giving documentation on functions and classes inside the files themselves.

It is not available in 3.0.x (because the devs didnt use it).

Brad: Did you manage to reduce the number of errors by changing configurations or is it the syntax that Jelsoft are using that is causing most of the errors?

[Brad]

sorry kinda confused, is this a phpdoc compilation of beta 4? are you going to update it in each new version

Yes this is beta 4 as noted in the zip file :). With each version I will generate new files.

I do plan on going back and cleaning up the .html files, right now they are what phpdoc generated with no modification.

Brad: Did you manage to reduce the number of errors by changing configurations or is it the syntax that Jelsoft are using that is causing most of the errors?

You can see the error log at /docs/vbsource/errors.html, while there are a lot listed there note that many of them are because of two things. Illegal use of 'var' and redeclared defines.

One thing for others that want to make their own phpdoc files, you need to tell phpdoc to pick up on a custom tag vB uses. Make sure you tell it to look for 'date' so it will extract @date.

Keep in mind that we are dealing with beta code, and I'm no phpdoc expert :). Even with the errors phpdoc still pulls a ton of useful information ;)

[Chris M]

2. Upload the folder /docs/ to your admin cp directory.
So why is the navigation link pointing to /forums/docs/ instead of /forums/admincp/docs/ ?:p

Remove the / before the docs in the link in the .xml file :p

Satan

[Abe1]

Brad, in the xml you should replace:
<link>/docs/vbsource/index.html</link>

with:
<link>./docs/vbsource/index.html</link>

[bigcurt]

doh! I got ya now, I guess I was thinking about somthing else/dreaming :-D

[Brad]

Hmmm strange it was right on localhost but wrong in the zip file, updating zip now (the joy of uploading 1.29MB on a 16.8k connection :rolleyes:)

[Brad]

Zip file updated, I also included a new screenshot as I thought the first one was kinda bare.

[mcncyo]

Is this going to be updated?

[DeMiNe0]

Doesn't look like it.

[Kirk Y]

He said he'd update it with each new release... I'd like to have this too... but I'm running RC2.

[Brad]

He said he'd update it with each new release... I'd like to have this too... but I'm running RC2.

I have not generated new docs in some time, I will make a note for myself to do so after I get out of class tonight.

[Kirk Y]

Excellent, looking forward to it! Many thanks.

[Brad]

Excellent, looking forward to it! Many thanks.

I have to grab the latest version from the members area, off to bed atm cause I have class in the morning but I'll set this to download tonight ;).

If I don't update tomorrow morning expect it sometime after lunch. :)

[Brad]

I did an update, now 3.5 RC3 documation is included in the zip file. :)

[WOTC_Boe]

Hello,

Thanks for providing the framework for getting phpDoc working with the admincp framework. is there any way you could post the phpdoc command you use to generate the documentation?

Also, do you use a *.ini file with phpDoc to generate the documentation? Can you share your config file?

Thanks Much!

Boe