Skip to content

Geometry_Engine & Structure_Engine: Update documentation links #3230

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

Merged
merged 2 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Geometry_Engine/Query/IsVertical.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public static partial class Query
[Description("Evaluates whether a line is vertical from its start- and endpoints projected 2d-distance")]
[Input("line", "The line to determine the verticality of")]
[Output("isVertical", "If it is vertical, as defined in the wiki.")]
[DocumentationURL("https://bhom.xyz/documentation/Conventions/BHoM-Structural-Conventions/", DocumentationType.Documentation)]
[DocumentationURL("https://bhom.xyz/documentation/BHoM_oM/Structure_oM/BHoM-Structural-Conventions/", DocumentationType.Documentation)]
public static bool IsVertical(this Line line)
{
return IsVertical(line.Start, line.End);
Expand Down
2 changes: 1 addition & 1 deletion Structure_Engine/Compute/ShearAreaPolyline.cs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public static partial class Compute
[Input("tol", "The tolerance for considering a line segment horizontal or vertical. /n" +
"i.e. (value at endpoint - value at startpoint) < tol.")]
[Output("shearArea", "The shear area of the section.")]
[DocumentationURL("https://bhom.xyz/documentation/Conventions/Shear-Area-Derivation/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
[DocumentationURL("https://bhom.xyz/documentation/BHoM_oM/Structure_oM/Shear-Area-Derivation/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
public static double ShearAreaPolyline(this Polyline pLine, double momentOfInertia, double tol = Tolerance.Distance)
{
if (pLine.IsNull())
Expand Down
2 changes: 1 addition & 1 deletion Structure_Engine/Query/IsVertical.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public static partial class Query
"For general structural conventions please see the documentation.")]
[Input("bar", "The Bar to check for verticality.")]
[Output("result", "Returns true if the Bar is vertical.")]
[DocumentationURL("https://bhom.xyz/documentation/Conventions/BHoM-Structural-Conventions/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
[DocumentationURL("https://bhom.xyz/documentation/BHoM_oM/Structure_oM/BHoM-Structural-Conventions/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
public static bool IsVertical(this Bar bar)
{
return bar.IsNull() ? false : Engine.Geometry.Query.IsVertical(bar.Centreline());
Expand Down
2 changes: 1 addition & 1 deletion Structure_Engine/Query/ShearArea.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public static partial class Query
[Input("momentOfInertia", "The moment of inertia around the axis orthogonal to the one being used to generate the slices.", typeof(SecondMomentOfArea))]
[Input("centroid", "The centroid of the curves along the axis used to generate the slices.", typeof(Length))]
[Output("shearArea", "The shear area calculated based on the slices.", typeof(Area))]
[DocumentationURL("https://bhom.xyz/documentation/Conventions/Shear-Area-Derivation/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
[DocumentationURL("https://bhom.xyz/documentation/BHoM_oM/Structure_oM/Shear-Area-Derivation/", oM.Base.Attributes.Enums.DocumentationType.Documentation)]
public static double ShearArea(List<IntegrationSlice> slices, double momentOfInertia, double centroid)
{
double sy = 0;
Expand Down