Documentation and code completion

[daithi-coombes]

25

End goal to have a build task that would build php docs (phpDoc2) on the current wordpress core and display results at localhost:4567/docs

also added *.logs to gitignore

[le-bott]

Merged build triggered.

[le-bott]

Merged build started.

[le-bott]

Merged build triggered.

[le-bott]

Merged build finished.

[mrdavidlaing]

@daithi-coombes I've ported this over to Rake.

Agree that we should have 2 doc tasks; one for "all" and one for "your code only"; where "your code only" is much quicker :)

I'll leave you to implement that.

[mrdavidlaing]

Actually, after playing with the generated docs a bit; I don't see why you would really want the WordPress core file docs - surely looking at the codex is going to be more useful.

I think we should only have the :docs task generate docs for "your" code?

[daithi-coombes]

one advantage would be that calls to wp functions would be referenced in their docs. But this does bring up another topic, the dev probably won't want to doc all themes/plugins as they're working on it. We can leave the wp core on the icebox but going to suggest:

rake docs plugin my_plugin
rake docs theme my_theme

on the iceboxed wp core... we could do a check on the version of wp in use and the version in the docs, if different then ask if they want to update them. Also phpdoc creates a structure.xml file Intermediate Structure File, I wonder how hard it would be to import this into netbeans or if other IDE's can read it, though haven't found anything online so far.

[mrdavidlaing]

Doesn't net beans just process the phpdoc comments in the source code itself to aid code completions?

On Saturday, April 13, 2013, daithi-coombes wrote:

one advantage would be that calls to wp functions would be referenced in their docs. But this does bring up another topic, the dev probably won't want to doc all themes/plugins as they're working on it. We can leave the wp core on the icebox but going to suggest:

rake docs plugin my_plugin rake docs theme my_theme

on the iceboxed wp core... we could do a check on the version of wp in use and the version in the docs, if different then ask if they want to update them. Also phpdoc creates a structure.xml file Intermediate Structure Filehttp://www.phpdoc.org/docs/latest/glossary.html, I wonder how hard it would be to import this into netbeans or if other IDE's can read it, though haven't found anything online so far.

— Reply to this email directly or view it on GitHubhttps://github.com/mrdavidlaing/pressupbox-development-boilerplate/pull/28#issuecomment-16340860 .

David Laing Open source @ City Index - github.com/cityindex http://davidlaing.com Twitter: @davidlaing

[daithi-coombes]

yep it will doc anything in the project as well as native php funcs, I was more talking about using the structure.xml file to add adittional doc's for the wp core, NetBeans Code Completion Tutorial. Giving a situation for netbeans dev's to have their project as /my-plugin-name (without wp core files) and still have the wp core files. But not sure by that tutorial how easy/hard it could be, would it eventually require a pressupbox-netbeans plugin?

[daithi-coombes]

requesting merge

syntax for calling rake documentator task:

rake docs[plugins, myPluginName]
rake docs[plugins, myThemeName]

[mrdavidlaing]

@daithi-coombes - Please fix the build first - its currently failing with:

Rakefile:156: invalid multibyte char (US-ASCII)

[mrdavidlaing]

retest this please