Ticket #2474 (closed defect (bug): fixed)

Opened 6 years ago

Last modified 4 years ago

Inline documentation for wpdb

Reported by: masquerade Owned by: anonymous
Priority: normal Milestone: 2.1
Component: Administration Version: 2.0.1
Severity: normal Keywords: phpdoc has-patch commit
Cc:

Description

As per the hackers thread. Against latest SVN revision

Attachments

wpdb-comments.diff Download (6.1 KB) - added by masquerade 6 years ago.
wpdb-comments-2.diff Download (6.1 KB) - added by masquerade 6 years ago.
wpdb-comments-3.diff Download (6.1 KB) - added by masquerade 6 years ago.
inline-docs-wpdb.diff Download (6.2 KB) - added by davidhouse 6 years ago.

Change History

comment:1   dto6 years ago

Should the @return line for the escape function read

@return string query safe string

or am I missing something?

  • Keywords inline-docs added

Here's a newer patch, with a few minor changes, mainly that I changed an int to string for the type for some methods, as I didn't realize the constants were declared to be strings.

Here's a newer patch, with a few minor changes, mainly that I changed an int to string for the type for some methods, as I didn't realize the constants were declared to be strings, and fixed a few minor typos in the 3rd and final patch.

  • Keywords commit added

I changed a few things:

  • Offsets ($x, $y are parameters to some functions) have been explained more clearly.
  • Docs for get_col_info are complete.

comment:6   ryan5 years ago

[4549] gets most of this in but some bits of the patch didn't apply. Anyone care to provide and updated patch?

comment:7   matt5 years ago

  • Status changed from new to closed
  • Resolution set to fixed

When there are more docs we can open new tickets.

  • Keywords phpdoc has-patch added; inline-docs removed
Note: See TracTickets for help on using tickets.