Feature/bma/detekt outdated doc #6084
Conversation
bmarty
requested review from
a team,
onurays and
ariskotsomitopoulos
and removed request for
a team
| @@ -90,7 +91,7 @@ interface PermalinkService { | |||
| * Creates a HTML or Markdown mention span template. Can be used to replace a mention with a permalink to mentioned user. | |||
| * Ex: "<a href=\"https://matrix.to/#/%1\$s\">%2\$s</a>" or "[%2\$s](https://matrix.to/#/%1\$s)" | |||
| * | |||
| * @param type: type of template to create | |||
| * @param type type of template to create | |||
There was a problem hiding this comment.
I have also removed some unnecessary :, but Detekt does not report that.
|
Thanks GitHub for having picked @ariskotsomitopoulos up to review this PR: I have added some documentation on the API about threads, I am not sure it is accurate. Maybe not update the doc here, but if you want to create dedicated PR to complete the doc about thread (especially in the Matrix SDK API), it will be appreciated. (only once this PR's been merged) |
bmarty
force-pushed
the
feature/bma/detekt_outdated_doc
branch
from
25ccaaa
to
805d2d2
Compare
| @@ -46,8 +46,8 @@ class MXUsersDevicesMap<E> { | |||
| /** | |||
| * Provides the object for a device id and a user Id. | |||
| * | |||
| * @param deviceId the device id | |||
| * @param userId the object id | |||
There was a problem hiding this comment.
should be * @param userId the user id instead of * @param userId the object id
| @@ -99,6 +99,7 @@ interface IntegrationManagerService { | |||
| * Offers to allow or disallow a native widget domain. | |||
| * @param widgetType the widget type to check for | |||
| * @param domain the domain to check for | |||
| * @param allowed true or false | |||
There was a problem hiding this comment.
* @param allowed true or false could be a bit more detailed
| @@ -65,7 +65,8 @@ interface WidgetPostAPIMediator { | |||
| /** | |||
| * Send an object response. | |||
| * | |||
| * @param klass the class of the response | |||
| * @param T the generic type | |||
There was a problem hiding this comment.
Not sure if * @param T the generic type is needed
There was a problem hiding this comment.
yes, it has to be documented. The doc does not bring a lot TBH.
| @@ -140,7 +140,7 @@ internal object MXMegolmExportEncryption { | |||
| * | |||
| * @param data the data to encrypt. | |||
There was a problem hiding this comment.
Nit: we don't need those spaces.
There was a problem hiding this comment.
yes, we should do a check on the whole codebase
| * @param baseType The base type for which this factory will create adapters. Cannot be Object. | ||
| * @param labelKey The key in the JSON object whose value determines the type to which to map the | ||
| * JSON object. | ||
| * @param fallbackType |
There was a problem hiding this comment.
Maybe somethink like * @param fallbackType alternative Type to try in case of the serialization fails
bmarty
force-pushed
the
feature/bma/detekt_outdated_doc
branch
from
e2b77d5
to
f5d0663
Compare
|
Rebased ( |
|
I do not know why GA are blocked. Let's merge, CI was happy before. |
Matrix SDKIntegration Tests Results:
|
Type of change
Content
Enable the rule
OutdatedDocumentationand fix all existing error reported by Detekt.The goal is not here to write the best documentation of the existing code, but is to ensure that Kdoc and documentation will not get worse.
Sometime
@paramname was not correct, sometimes it some@paramwas missing, sometimes not in the correct order, sometime@paramwas used instead of@property.Note that this rule does not complain if there is no
@paramin the Kdoc.Motivation and context
Improve documentation quality, especially SDK API documentation
Screenshots / GIFs
N/A
Tests
N/A