More Documentation

[ericlewis]

There's a lot of BuddyPress functionality that is undocumented inline, and could benefit from added documentation.

[ericlewis]

What would be the best way to approach this? One master ticket here?

[boonebgorges]

I think one master ticket is fine, but it would be best (imho) if patches themselves were broken up into chunks. Like maybe, don't include docs for more than one file in a single diff. That'll make sure that there are fewer problems applying cleanly, and it'll make things easier to review.

Putting in Future Release as I assume it'll be an ongoing project.

[ericlewis]

Add block descriptions for rebuild_activity_comment_tree, get_child_comments, and get_recorded_components

[ericlewis]

more thorough work of bp-activity-classes from 5022.diff.

[boonebgorges]

I'd also like to use this as a master ticket for improving existing docblocks, for better adherence to the WP standards described here ​http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/

[boonebgorges]

In 7390:

Inline doc improvements for bp-activity-actions.php

See #5022

[boonebgorges]

In 7391:

Inline doc improvements for bp-activity-admin.php

See #5022

[boonebgorges]

In 7393:

Additional documentation and docs standards adherence in bp-activity-classes.php

See #5022

Props ericlewis

[boonebgorges]

In 7395:

Inline doc improvements for bp-activity-akismet.php

See #5022

[boonebgorges]

In 7396:

Inline doc improvements for bp-activity-cache.php

See #5022

[boonebgorges]

In 7397:

Inline doc improvements in bp-activity-filters.php

See #5022

[boonebgorges]

In 7398:

Inline docs improvements in bp-activity-functions.php and -classes.php

See #5022

[boonebgorges]

In 7399:

Improve inline docs in bp-core-component.php.

See #5022

[boonebgorges]

In 7400:

Improve inline docs in bp-activity-loader.php

See #5022

[boonebgorges]

In 7401:

Improve inline docs in bp-activity-notifications.php

See #5022

[boonebgorges]

In 7403:

Fixes some incorrect documentation syntax

See #5022

[boonebgorges]

In 7404:

Improve inline docs for bp_core_fetch_avatar()

See #5022

[boonebgorges]

In 7405:

Improve inline docs in bp-activity-template.php.

See #5022

[boonebgorges]

In 7406:

Documentation whitespace improvement in bp-activity-functions.php

See #5022

[boonebgorges]

In 7407:

Inline docs improvements in Blogs component:

• bp-blogs-actions.php
• bp-blogs-activity.php
• bp-blogs-buddybar.php
• bp-blogs-cache.php
• bp-blogs-classes.php

See #5022

[boonebgorges]

In 7409:

Improve inline docs in Blogs component.

See #5022.

[boonebgorges]

In 7428:

Whitespace improvements for bp_core_fetch_avatar() docblock

See #5022

[boonebgorges]

In 7429:

Improve inline docs in bp-blogs-template.php

See #5022

[boonebgorges]

In 7433:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7434:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7444:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7445:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7446:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7449:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7451:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7452:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7457:

Improve inline docs in bp-core. See #5022

[boonebgorges]

In 7468:

Improve inline docs in bp-forums. See #5022

[boonebgorges]

In 7472:

Improve inline docs in bp-activity-admin.php. See #5022

[boonebgorges]

In 7476:

Improve inline docs in bp-core-catchuri.php. See #5022

[boonebgorges]

In 7554:

Improve inline docs in bp-forums component. See #5022

[boonebgorges]

In 7556:

Improve inline docs in bp-friends. See #5022

[boonebgorges]

In 7558:

Improve inline docs in bp-friends component. See #5022

[boonebgorges]

In 7560:

Improve inline docs in bp-friends component. See #5022

[boonebgorges]

In 7561:

Improve inline docs in bp-groups component. See #5022

[boonebgorges]

In 7644:

Improve documentation in the Friends component. See #5022

[boonebgorges]

In 7645:

Improve documentation in the Groups component. See #5022

[boonebgorges]

In 7648:

Improve inline documentation in bp-groups. See #5022

[boonebgorges]

In 7760:

Improve inline docs in bp-loader.php. See #5022

[boonebgorges]

In 8318:

Improved documentation in Members component. See #5022

[boonebgorges]

In 8319:

Improve inline documentation in Members component. See #5022.

[boonebgorges]

In 8335:

Improved documentation in Members component. See #5022

[boonebgorges]

In 8479:

Improved inline documentation in bp-messages.

See #5022

[boonebgorges]

In 8481:

Improve inline documentation in bp-messages.

See #5022

[boonebgorges]

In 8482:

Improved inline documentation in the Messages component.

See #5022

[boonebgorges]

In 8530:

Improved formatting for docblocks in bp-activity-functions.php

See #5022

[boonebgorges]

In 8533:

Improved documentation for xprofile_insert_field()

See #5022

[boonebgorges]

In 9025:

Improve inline documentation for Notifications component.

See #5022

[boonebgorges]

In 9026:

Improved inline documentation in bp-groups

See #5022

[boonebgorges]

In 9027:

Improved inline documentation in bp-groups

See #5022

[boonebgorges]

In 9028:

Inline documentation improvements for part of bp-groups-template.php

It's a big file

See #5022

[boonebgorges]

In 9046:

Some improvements to inline documentation in bp-groups-template.php

See #5022

[boonebgorges]

In 9048:

Some improved documentation in bp-groups-template.php

See #5022

[boonebgorges]

In 9057:

Improved documentation in bp-groups-template.php

See #5022

[tw2113]

I'll take over this one from here. :)

[tw2113]

In 10417:

Adds @since tags to the docblocks at the top of the files.

See #5022.

[tw2113]

I think this one is well covered enough to mark as closed. Though since it doesn't have a specific release, marking as "worksforme"