search

fabacab / multisite-directory

:card_index::globe_with_meridians: Add a browseable, flexible directory of the sites in a WP Multisite network.
https://wordpress.org/plugins/multisite-directory/
GNU General Public License v2.0
1 stars 6 forks source link

Automate themeing function documentation in readme file #6

Open fabacab opened 8 years ago

fabacab commented 8 years ago

See 55507b052c5656c636cb28c5d305937747557bac for the expected input/output, this should be automated and not a copy-paste-edit manual operation.

fabacab commented 8 years ago

This is actually a general problem that should be solved for all plugins, so I'm gonna write a phpDoc template to do this. Progress will be tracked there.

misfist commented 8 years ago

Yes, that would be great! I forget to do it all the time!

Also, can you recommend a plugin boilerplate that isn't totally overblown? I've tried https://github.com/DevinVinson/WordPress-Plugin-Boilerplate, but find it too much for most of my needs.

fabacab commented 8 years ago

I've never made a phpDoc template before so I could use some help figuring out how to do it. Especially considering phpDocumentor's documentation, ironically, sucks.

As for a boilerplate, no, I don't like any. I always get the feeling that their creators are like, "this project is for a boilerplate, so what it really needs is more boilerplate," and I just do a headdesk cuz, augh, that is the opposite of the point.

I tend to use my own skeleton code as a starting point a lot, which is similar to WP-CLI's scaffold plugin and that's often more than enough for me to get started.

misfist commented 8 years ago

I've never done it either :/ They make it look easy here: https://phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html#running-phpdocumentor

Thanks for the skeleton link, I'll check it out.

fabacab commented 8 years ago

Yeah, those are docs about how to generate docs, not how to customize the output template. If you follow through the links you'll find a lot of dead ends. I resorted to reading the templates phpDoc ships with and trying to poke it in enough different ways to do what I want. I was able to get as far as correctly looping over the functions defines in a single file, but that's all. Anyway this should probably be discussed over at the other repo's issue queue. Any help would be appreciated but don't stress, I know you have a day job and I don't have that burden.