Page MenuHomePhabricator

The Doxygen documentation for WANObjectCache::getWithSetCallback has a formatting error
Closed, ResolvedPublic

Description

In https://doc.wikimedia.org/mediawiki-core/master/php/classWANObjectCache.html#a61d34b2b8cc2b3079670589751458f04, there are <dl>, <dt> and <dd> elements which are not intended.

Screenshot 2022-03-07 at 22.04.29.png (580×2 px, 132 KB)

<ul>
<li>$oldValue: prior cache value or false if none was present</li>
<li>&amp;$ttl: alterable reference to the TTL to be assigned to the new value</li>
<li>&amp;$setOpts: alterable reference to the <a class="el" href="classWANObjectCache.html#aa1eb038eb185a1c98fd58f5ab0479f3b" title="Set the value of a key in cache.">set()</a> options to be used with the new value</li>
<li><dl class="section rcs"><dt>oldAsOf</dt><dd>generation UNIX timestamp of </dd></dl>
oldValue or null if not present (since 1.28)</li>
<li><dl class="section rcs"><dt>params</dt><dd>custom field/value map as defined by </dd></dl>
cbParams (since 1.35)</li>
</ul>

The code of it is: (https://phabricator.wikimedia.org/source/mediawiki/browse/master/includes/libs/objectcache/wancache/WANObjectCache.php$1201)

/**
 *   - $oldValue: prior cache value or false if none was present
 *   - &$ttl: alterable reference to the TTL to be assigned to the new value
 *   - &$setOpts: alterable reference to the set() options to be used with the new value
 *   - $oldAsOf: generation UNIX timestamp of $oldValue or null if not present (since 1.28)
 *   - $params: custom field/value map as defined by $cbParams (since 1.35)
 */

Related Objects

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Change 765662 had a related patch set uploaded (by Aaron Schulz; author: Aaron Schulz):

[mediawiki/core@master] objectcache: improve doxygen output for WANObjectCache::getWithSetCallback()

https://gerrit.wikimedia.org/r/765662

Change 768843 had a related patch set uploaded (by Krinkle; author: Krinkle):

[integration/config@master] dockerfiles: Upgrade Doxygen to 1.9.1

https://gerrit.wikimedia.org/r/768843

Change 768843 merged by jenkins-bot:

[integration/config@master] dockerfiles: Upgrade Doxygen to 1.9.1

https://gerrit.wikimedia.org/r/768843

Change 769763 had a related patch set uploaded (by Krinkle; author: Krinkle):

[integration/config@master] jjb: Upgrade Doxygen to 1.9.1

https://gerrit.wikimedia.org/r/769763

Change 769763 merged by jenkins-bot:

[integration/config@master] jjb: Upgrade Doxygen to 1.9.1

https://gerrit.wikimedia.org/r/769763

Change 765662 abandoned by Krinkle:

[mediawiki/core@master] objectcache: improve doxygen output for WANObjectCache::getWithSetCallback()

Reason:

Task resolved by other means

https://gerrit.wikimedia.org/r/765662