Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show return type for methods and properties on Members page #138

Open
onomou opened this issue Apr 14, 2022 · 2 comments
Open

Show return type for methods and properties on Members page #138

onomou opened this issue Apr 14, 2022 · 2 comments

Comments

@onomou
Copy link

onomou commented Apr 14, 2022

I think it would be very helpful to see what is returned without having to click on a method or property.

For example, the Element Members page lists methods such as ArePhasesModifiable with Public method icon and Description. Only after clicking on the method link can one see under Syntax that it returns a bool.

public [bool] ArePhasesModifiable()

Same with properties, such as AssemblyInstanceId. Under Syntax it shows that it is an ElementId.

public [ElementId] AssemblyInstanceId { get; }

Having that information available in the members page would save so many clicks:

Icon Returns Name Description
Public method bool ArePhasesModifiable Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
...
Public property ElementId AssemblyInstanceId The id of the assembly instance to which the element belongs.
...
@gtalarico
Copy link
Owner

gtalarico commented Apr 15, 2022

That would be great @onomou
revitapidocs mostly simply renders the documentation generated by autodesk revit developers (@jeremytammik)
so this change would need to be done by then.
It wouldn't be impossible to crawl documents to fetch types from deeper pages and then re-write the parent table, but that's not something I would consider since it could introduce errors and would require a lot of work.

@jeremytammik
Copy link

Thank you for the suggestion! I asked the Revit development team for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants