Updated: Comment #0

Problem/Motivation

Related to #2197431: [policy, no patch] Exempt migrate_drupal from coding standards

Proposed resolution

Meet https://drupal.org/core-gates#documentation-block-requirements

Remaining tasks

issue summary details to be added.

User interface changes

No.

API changes

No. (Maybe some type hints. But should not really be changes to core APIs.)

CommentFileSizeAuthor
#3 no_dox-v2.txt4.53 KBmarvil07
#2 no_dox.txt10.1 KBchx

Comments

marvil07’s picture

marvil07 commented

One step:
17d5984 migrate_drupal cleanup: Added visibility to methods without it.

chx’s picture

chx commented
StatusFileSize
new no_dox.txt10.1 KB

yay! Please find a list attached, it contains the files and line numbers where there's an empty line before a function definition -- these are somewhat obviously missing doxygen, 99% of them will be {@inheritdoc} I am sure.

marvil07’s picture

marvil07 commented
StatusFileSize
new no_dox-v2.txt4.53 KB 
bda5c1d cleanup: Added visibility to methods without it outside migrate_drupal.
da986bb Complete several missing doxygen blocks.

Some missing doxygen:

  • on several interface methods, some help here would be great, since they help to understand basic interactions
  • *Test::setDatabase()
  • *Test::setModuleHandler()
  • *Test::setCallable()
  • *Test::setDelimiter()
  • maybe other methods on *Test for local testing.
chx’s picture

chx commented

> *Test::setDatabase()
> *Test::setModuleHandler()

These are setter injections but they aren't on the base class because it'd be wrong to run them outside of a test environment. They set the database connection / module handler. Check their getters.

> *Test::setCallable()
> *Test::setDelimiter()

These are on 1-1 process plugins AFAIK and they set the specific configuration value -- the one we want to test actually. Without such a method we wouldn't be able to change the configuration on the fly; that's not something that plugins support (or even should support).