There are some @todo docblocks in the config system that have yet to be filled in.

Files: 
CommentFileSizeAuthor
#1 1516472-1.config-api-doc.patch12.29 KBksenzee
PASSED: [[SimpleTest]]: [MySQL] 36,047 pass(es). View

Comments

ksenzee’s picture

Title: missing API documentation » missing API documentation for configuration system
Component: configuration system » documentation
Status: Active » Needs review
FileSize
12.29 KB
PASSED: [[SimpleTest]]: [MySQL] 36,047 pass(es). View

I guess this should probably be filed under documentation.

jhodgdon’s picture

Status: Needs review » Needs work

This looks great! A couple of things I wasn't sure of or that need to be fixed:

a)

+++ b/core/lib/Drupal/Core/Config/DrupalConfigVerifiedStorage.php
...
+   * @throws Exception
    */
   public function readFromFile() {
+    // @todo: Catch the exception thrown from SignedFileStorage::read().

Should it be more specific about which exception(s) it throws? There are a couple of other @throws Exception lines too... Maybe at least put in a @todo that says "figure out which specific exceptions can be thrown"?

b)

+++ b/core/lib/Drupal/Core/Config/DrupalConfigVerifiedStorageInterface.php
...
+   * @see config_get_verified_storage_names_with_prefix
    */
   static function getNamesWithPrefix($prefix);

Function name needs () after it in @see to turn into a link.

jhodgdon’s picture

Issue tags: +Novice

Fixing these two items would be a good Novice project... maybe we can get this done?

sun’s picture

Title: missing API documentation for configuration system » Missing/incorrect API documentation for configuration system
Status: Needs work » Postponed
Issue tags: -Novice +Configuration system

Not particularly novice, I think. AFAICS, most of the changes in #1 should be obsolete or done by now already.

I'd suggest to leave this issue open, but postpone it to later, since the config system is still undergoing massive changes.

jhodgdon’s picture

Issue summary: View changes
Status: Postponed » Closed (works as designed)

These particular ToDo items have all vanished. I don't see any docs ToDos in the Config system right now. Closing this issue.