XmlBinaryWriterSession.TryAdd: incorrect description of return values

Link to the documentation

The description of return values is as follows:

Returns
Boolean
true if the string could be added; otherwise, false.

But in fact the TryAdd method never returns false.

The code:

public virtual bool TryAdd(XmlDictionaryString value, out int key)
{
    ArgumentNullException.ThrowIfNull(value);

    IntArray? keys;

    if (_maps.TryGetValue(value.Dictionary, out keys))
    {
        key = (keys[value.Key] - 1);

        if (key != -1)
        {
            // If the key is already set, then something is wrong
            throw System.Runtime.Serialization.DiagnosticUtility.ExceptionUtility.ThrowHelperError(new InvalidOperationException(SR.XmlKeyAlreadyExists));
         }

         key = Add(value.Value);
         keys[value.Key] = (key + 1);
         return true;
    }

    key = Add(value.Value);
    keys = AddKeys(value.Dictionary, value.Key + 1);
    keys[value.Key] = (key + 1);
    return true;
}

Link to the sources

The TryAdd method returns true or throws an exception, but it doesn't return false.

Beginne mit der verknüpften API-Dokumentation zu XmlBinaryWriterSession.TryAdd und vergleiche deren Abschnitt Returns mit dem Quellcode unter src/libraries/System.Private.DataContractSerialization/src/System/Xml/XmlBinaryWriterSession.cs. Aktualisiere die Beschreibung des Rückgabewerts so, dass sie dem Verhalten der Methode entspricht, und überprüfe anschließend die gerenderte API-Dokumentation.