Commented version of index.php?

[rrottman]

Maybe a stupid question but worth a try:

Does anybody have a "fully commented" version of index.php or any other vB page / file available? As I think there is at present a leck of developer documentation with vBulletin, it might make sense to launch an initiative to fully comment each line of the .php files, maybe as a joined initiative.

What do you think? Generally a good idea?
Who would be able to contribute?

[MindTrix]

Would make the size of the files much bigger though

[NTLDR]

It is against vBulletin's licence agreement to distribute vB files. This means if anyone did have a fully commented one they wouldn't be able to send it to you as it violates the licence agreement. This is also one of the reasons full vB files are not allowed to be posted here.

[rrottman]

Originally Posted by NTLDR

It is against vBulletin's licence agreement to distribute vB files. This means if anyone did have a fully commented one they wouldn't be able to send it to you as it violates the licence agreement. This is also one of the reasons full vB files are not allowed to be posted here.

@NTLDR:
Fair point.
Would it be an option to just make it available to licensed customers? I'm not thinking of anything like redistributing, it's merely an idea to support the developer community. I sometime wonder what's going on in these files, eventhough I do have a solid understanding of PHP.

[NTLDR]

Unfortunately not, while it would be a good resource its still not possible. Feel free to contact Jelsoft about it, but I'm pretty confident they'll say no to the idea.

[rrottman]

Originally Posted by NTLDR

Unfortunately not, while it would be a good resource its still not possible. Feel free to contact Jelsoft about it, but I'm pretty confident they'll say no to the idea.

Hmm, i guess you might be right.
Would it be an option if we would create separate "about" files, documenting the code by refering to a line number but without replicating the actual code?

[NTLDR]

That would be fine. You can copy the odd line of code, but copying large chunks of code or whole files isn't allowed.

[rrottman]

Hmm...
... Would it then probably be worth a try to get a group of contributors together, organize this as a joined effort in the style of a sourceforge project, call it the vB "developer documentation project" for example :-) get a site up and running and just kick it off?

I'd be happy to provide some webspace and programming in order to manage the process, however I'd really appreciate to get some opinions from other vB pros as to whether it could be done and they would possibly contribute.