From 0ece7d5f0fdaefd05a3396e96f449df2efafb5cd Mon Sep 17 00:00:00 2001 From: Fraser Greenroyd Date: Wed, 19 Oct 2022 18:12:02 +0100 Subject: [PATCH] Fix compliance of CanvasID file --- Grasshopper_Engine/Query/CanvasID.cs | 29 +++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/Grasshopper_Engine/Query/CanvasID.cs b/Grasshopper_Engine/Query/CanvasID.cs index 9c1a1a17..5ec36b76 100644 --- a/Grasshopper_Engine/Query/CanvasID.cs +++ b/Grasshopper_Engine/Query/CanvasID.cs @@ -1,4 +1,26 @@ -using System; +/* + * This file is part of the Buildings and Habitats object Model (BHoM) + * Copyright (c) 2015 - 2022, the respective contributors. All rights reserved. + * + * Each contributor holds copyright over their respective contributions. + * The project versioning (Git) records all such contribution source information. + * + * + * The BHoM is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3.0 of the License, or + * (at your option) any later version. + * + * The BHoM is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this code. If not, see . + */ + +using System; using System.Collections.Generic; using System.Linq; using System.Text; @@ -6,11 +28,16 @@ using GH = Grasshopper; using Grasshopper.Kernel; +using System.ComponentModel; +using BH.oM.Base.Attributes; namespace BH.Engine.Grasshopper { public static partial class Query { + [Description("Gets a unique ID for a Grasshopper document based on the runtime ID of the document linked to a GUID. Valid only for the active session and will not be the same across sessions. Reloading Grasshopper will produce new IDs for the same files on a new load. This is predominantly used for Analytics.")] + [Input("document", "A Grasshopper document to obtain a unique GUID from for the given runtime ID.")] + [Output("canvasID", "A GUID set as a string to uniquely identify the session instance of the canvas.")] public static string CanvasID(this GH_Document document) { if (document == null)