Skip to content

[doc] Update the documentation for properties#749

Merged
adangel merged 7 commits into
pmd:masterfrom
oowekyala:properties-doc
Nov 24, 2017
Merged

[doc] Update the documentation for properties#749
adangel merged 7 commits into
pmd:masterfrom
oowekyala:properties-doc

Conversation

@oowekyala

Copy link
Copy Markdown
Member

The old page was heavily outdated, and I figured there was nothing to save.

This checks another item on #504 (nearly there). The last one is "document the API changes", I might have time to do it next week-end.

Note that I've acknowledge that #736 is scheduled for 6.1.0, so this will have to be updated in case it makes it in time for 6.0.0

That part was about developing a UI for an IDE plugin. The info was heavily outdated, and the up to date info can be found in the javadoc of the PropertyDescriptor interface.

@adangel adangel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks!
I'll adjust the two class names and merge it.

|CharacterProperty|char
|FileProperty|java.io.File
|MethodProperty|java.reflect.Method
|TypeProperty|java.reflect.Class\<?\>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually java.lang.Class\<?\>

|BooleanProperty|boolean
|CharacterProperty|char
|FileProperty|java.io.File
|MethodProperty|java.reflect.Method

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is java.lang.reflect.Method

@adangel adangel added this to the 6.0.0 milestone Nov 24, 2017
@adangel adangel added the in:documentation Affects the documentation [doc] label Nov 24, 2017
@adangel adangel merged commit 9c0b865 into pmd:master Nov 24, 2017
adangel added a commit that referenced this pull request Nov 24, 2017
@oowekyala oowekyala deleted the properties-doc branch November 24, 2017 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants