First Question ... API docs and/or examples?

[RickM]

Could ideally do with some info as to what the other code event listeners are for/do as their id's leave it a little vague.

 

[Jafo]

Some of this will take some getting used to. I have been modding vb for so long I am excited to learn some new stuff! I for one would LOVE to see more videos like this one! That really helped me out.

 

[Benjy]

I'm trying to generate the API/Documentation using phpDocumentor,
but the memory limit (256M) gets exhausted every time.

Here are the docs, as generated by phpDocumentor (Zend, SabreDAV excluded): http://ul.to/zd0r15 (format: 7zip)

NB: I'm no expert in phpDoc so I may have chosen a wrong template or have had missing options.

 

[Shadab]

Here are the docs, as generated by phpDocumentor (Zend, SabreDAV excluded): http://ul.to/zd0r15 (format: 7zip)

Thanks a lot!

 

[RickM]

Benjay - great work! Hope you dont mind, but I re-archived it as a zip and placed it at the following dropbox URL (simply because the download site posted is full of ads and makes you wait aaagggeeesss to download a file, plus not many people use 7zip anymore

Anyway, here: http://dl.dropbox.com/u/534835/XenForo_docs.zip

 

[Lawrence]

Could ideally do with some info as to what the other code event listeners are for/do as their id's leave it a little vague.

The Code Events come with descriptions that help a lot. When I first seen them I found them difficult to understand, until I understood XF's model. Now looking at the Listener's name I can tell if that is the one I need to use or not.

 

[borbole]

Hi guys 'n' gals.

Looking forward to getting my teeth into some serious XF mod development.

So the obvious first question ... is there anything by way of API docs or examples yet?

-- hugh

Have a look at this guide here. It will help you a lot.

http://xenforo.com/community/threads/creating-an-addon.5416/

 

[Jeremy]

The Code Events come with descriptions that help a lot. When I first seen them I found them difficult to understand, until I understood XF's model. Now looking at the Listener's name I can tell if that is the one I need to use or not.

I still don't fully understand XenForo, but I too have been able to decipher what I need just by the names.

 

[Benjy]

Here are the updated docs: http://dl.dropbox.com/u/14050750/xenforo_1.0.0-Beta-2_docs.zip

 

[Shadab]

Here are the updated docs: http://dl.dropbox.com/u/14050750/xenforo_1.0.0-Beta-2_docs.zip

Benjy, would it be possible for you to generate the docs for Beta 5 with the following settings:

• Output format: HTML:Smarty:PHP
• Documentation Title: XenForo 1.0
• Default Package Name: XenForo_Mvc

For the life of me, I'm *still* unable to generate the documentation myself. The script just silently dies while reading the source php files (ie, General Parsing Stage). No errors are shown, the php-cgi.exe process doesn't die, and nothing is logged in php's error log.

 

[Benjy]

Benjy, would it be possible for you to generate the docs for Beta 5 with the following settings:

• Output format: HTML:Smarty:PHP
• Documentation Title: XenForo 1.0
• Default Package Name: XenForo_Mvc

For the life of me, I'm *still* unable to generate the documentation myself. The script just silently dies while reading the source php files (ie, General Parsing Stage). No errors are shown, the php-cgi.exe process doesn't die, and nothing is logged in php's error log.

Here you go: http://dl.dropbox.com/u/14050750/xenforo_1.0.0-Beta-5_docs.zip

 

[Benjy]

Here are the Release Candidate 2 docs:
http://dl.dropbox.com/u/14050750/xenforo_1.0.0-Release-Candidate-2_docs.zip

 

[DroidHost]

Here are the Release Candidate 2 docs:
http://dl.dropbox.com/u/14050750/xenforo_1.0.0-Release-Candidate-2_docs.zip

it is not working !

 

[Paul B]

Works fine for me - just downloaded and extracted without a problem.

 

[DroidHost]

I go to index but every time clicking a link for any of the function it gives me nothing ?

 

[RickM]

I go to index but every time clicking a link for any of the function it gives me nothing ?

What browser are you on? It's probably downloading in the background into your default downloads directory.

 

[Benjy]

There is a bug with the PhpDocumentor package (some templates and files have a 2-chars extension instead of 3-chars).
I corrected it (and removed the notices showing on some pages) and re-generated the docs. The link is the same as before.

EDIT: quick'n'dirty edit of the main CSS to look more like XF

 

[DarkSign]

Thanks for the 1.0 docs. I tried to use phpdocumentor 2 to generate the 1.1 docs, but it failed

So, if someone could get it to work with 1.1, please share the generated docs. Thank you in advance.

 

[Cheesegrits]

I finally got a 1.1.4 phpdoc generated, by bumping memory_limit up to a gig and letting phpdocumentor chew on it for about 45 minutes.

I don't know how long I'll leave it up, but for the moment, the 1.1.4 docs can be found at:

http://fabrikar.com/forums/docs/packages/XenForo.html

-- hugh

 

[euantor]

There's also my docs that have been up for a while: http://xf.euantor.com/ DO like the styling of yours though.

Do need to update them for 1.1.4 but I don't think there were an major class changes or anything.