Skip to content

Handle javadoc translation for {@param} tags #1042

Closed
@pjcollins

Description

@pjcollins

The javadoc for DevicePolicyManager#getTrustAgentConfiguration is not translated appropriately:

<javadoc>
<![CDATA[Gets configuration for the given trust agent based on aggregating all calls to
{@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
all device admins.
<p>
This method can be called on the {@link DevicePolicyManager} instance returned by
{@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
on the parent profile.
<p>
On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, null is
always returned.

@param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
this function returns a list of configurations for all admins that declare
{@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
{@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
{@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
for this {@param agent} or calls it with a null configuration, null is returned.
@param agent Which component to get enabled features for.
@return configuration for the given trust agent.]]>
</javadoc>

The occurrence of {@param agent} causes an issue in our docs:

<param name="admin">Which <c>DeviceAdminReceiver</c> this request is associated with. If null,
    this function returns a list of configurations for all admins that declare
    <c>#KEYGUARD_DISABLE_TRUST_AGENTS</c>. If any admin declares
    <c>#KEYGUARD_DISABLE_TRUST_AGENTS</c> but doesn't call
    <c>#setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)</c>
    for this {</param>
<param name="agent}}">or calls it with a null configuration, null is returned.</param>
<param name="agent">Which component to get enabled features for.</param>
<summary>Gets configuration for the given trust agent based on aggregating all calls to
    <c>#setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)</c> for
    all device admins.</summary>
<returns>configuration for the given trust agent.</returns>

Metadata

Metadata

Assignees

Labels

bugComponent does not function as intendedjavadocIssues with consuming Java documentation formats

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions