revitapidocs icon indicating copy to clipboard operation
revitapidocs copied to clipboard

Show return type for methods and properties on Members page

Open onomou opened this issue 3 years ago • 2 comments

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.
...

onomou avatar Apr 14 '22 18:04 onomou

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.

gtalarico avatar Apr 15 '22 17:04 gtalarico

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

jeremytammik avatar Apr 15 '22 17:04 jeremytammik