The Tables class in core/modules/field_sql_storage/lib/Drupal/field_sql_storage/Entity/Tables has really bad documentation on its member variables and functions:
- At least one variable is missing a summary line describing what it is.
- At least one function is missing a summary line describing what it is.
- At least one function is completely lacking a documentation header.
- Many of the parameters lack documentation of what they are. For instance, this gem:
* @param string $field
* If it contains a dot, then field name dot field column. If it doesn't
* then entity property name.If *what* contains a dot? What does this represent really?
- Not all parameters of all methods are documented at all with @param
- Some of the @param/@return docs do not have descriptive text at all.
- Some of the docs standards on http://drupal.org/coding-standards/docs are being followed:
-- There should be a blank line between the @param section and @return section in function docs.
-- If namespaces are used in docs, they should always be fully qualified (start with \ ).
-- Function docs start with a verb in 3rd person (Joins not Join).
I thought we had minimal documentation standards for patches to be committed? This isn't even close. Sigh.