Skip to content

Commit de7e78c

Browse files
codestackdevcodestackdev
committed
Added more comments, updated documentation
1 parent dbae807 commit de7e78c

File tree

10 files changed

+67
-7
lines changed

10 files changed

+67
-7
lines changed

‎Framework/Core/DocumentHandler.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,21 @@ public class DocumentHandler : IDocumentHandler
3131
private readonly ConfigurationChangeEventsHandler m_ConfigurationChangeEventsHandler;
3232
private readonly Access3rdPartyDataEventsHandler m_Access3rdPartyDataEventsHandler;
3333

34+
/// <summary>
35+
/// Raised when document is initialized
36+
/// </summary>
37+
/// <remarks>Initialization happens when model loads into a memory (e.g. opening the file, unsuppressing component, resolving component from lightweight mode)</remarks>
3438
public event DocumentStateChangedDelegate Initialized;
39+
40+
/// <summary>
41+
/// Raised when model window is activated
42+
/// </summary>
3543
public event DocumentStateChangedDelegate Activated;
44+
45+
/// <summary>
46+
/// Raised when document is closed
47+
/// </summary>
48+
/// <remarks>This event will also be raised when add-in unloads but documents are still open</remarks>
3649
public event DocumentStateChangedDelegate Destroyed;
3750

3851
/// <summary>

‎Framework/Delegates/ItemModifyDelegate.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ namespace CodeStack.SwEx.AddIn.Delegates
1616
/// </summary>
1717
/// <param name="docHandler">Document Handler which sends this notification</param>
1818
/// <param name="action">Item modification type</param>
19-
/// <param name="entType">Modified entity type as described in <see href="http://help.solidworks.com/2017/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swNotifyEntityType_e.html">swNotifyEntityType_e</see> enumeration</param>
19+
/// <param name="entType">Modified entity type as defined in <see href="http://help.solidworks.com/2017/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swNotifyEntityType_e.html">swNotifyEntityType_e</see> enumeration</param>
2020
/// <param name="name">Name of the item</param>
2121
/// <param name="oldName">Old name of the item if <see cref="ItemModificationAction_e.PreRename"/> or <see cref="ItemModificationAction_e.Rename"/> operation</param>
2222
public delegate void ItemModifyDelegate(DocumentHandler docHandler, ItemModificationAction_e action, swNotifyEntityType_e entType, string name, string oldName = "");

‎Framework/Delegates/ObjectSelectionDelegate.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace CodeStack.SwEx.AddIn.Delegates
1515
/// Delegate of <see cref="DocumentHandler.Selection"/> event
1616
/// </summary>
1717
/// <param name="docHandler">Document Handler which sends this notification</param>
18-
/// <param name="selType">Type of the selected object as described in <see href="http://help.solidworks.com/2014/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swSelectType_e.html">swSelectType_e</see> enumeration</param>
18+
/// <param name="selType">Type of the selected object as defined in <see href="http://help.solidworks.com/2014/english/api/swconst/SolidWorks.Interop.swconst~SolidWorks.Interop.swconst.swSelectType_e.html">swSelectType_e</see> enumeration</param>
1919
/// <param name="state">Type of the selection operation</param>
2020
/// <returns>Return false if <see cref="SelectionState_e.UserPreSelect"/> to cancel the user selection</returns>
2121
public delegate bool ObjectSelectionDelegate(DocumentHandler docHandler, swSelectType_e selType, SelectionState_e state);

‎Framework/Enums/ConfigurationChangeState_e.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace CodeStack.SwEx.AddIn.Enums
99
{
1010
/// <summary>
11-
/// States of configuration changes
11+
/// States of configuration or sheet changes
1212
/// </summary>
1313
public enum ConfigurationChangeState_e
1414
{

‎Framework/Framework.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package >
33
<metadata>
44
<id>CodeStack.SwEx.AddIn</id>
5-
<version>0.7.6</version>
5+
<version>0.8.0</version>
66
<title>Development tools for SOLIDWORKS add-ins</title>
77
<authors>CodeStack</authors>
88
<owners>CodeStack</owners>

‎Framework/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@
1414

1515
[assembly: Guid("451b36d1-79a5-48c4-af1f-79d6bff7f3e9")]
1616

17-
[assembly: AssemblyVersion("0.7.6.0")]
18-
[assembly: AssemblyFileVersion("0.7.6.0")]
17+
[assembly: AssemblyVersion("0.8.0.0")]
18+
[assembly: AssemblyFileVersion("0.8.0.0")]

‎HelpDoc/Content/VersionHistory/VersionHistory.aml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
<para>Select a version below to see a description of its changes.</para>
1212

1313
<list class="bullet">
14+
<listItem>
15+
<para>
16+
<link xlink:href="v0-8-0" />
17+
</para>
18+
</listItem>
1419
<listItem>
1520
<para>
1621
<link xlink:href="v0-7-6" />

‎HelpDoc/Content/VersionHistory/v0.8.0.aml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="v0-8-0" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<para>
6+
Version 0.8.0 was released on October 2 2019.
7+
</para>
8+
</introduction>
9+
10+
<section>
11+
<title>Enhancements</title>
12+
<content>
13+
14+
<list class="bullet">
15+
<listItem>
16+
<para>
17+
<externalLink>
18+
<linkText>Issue 30</linkText>
19+
<linkUri>https://github.com/codestackdev/swex-addin/issues/30</linkUri>
20+
</externalLink> Add the support for common events
21+
</para>
22+
</listItem>
23+
<listItem>
24+
<para>
25+
<externalLink>
26+
<linkText>Issue 31</linkText>
27+
<linkUri>https://github.com/codestackdev/swex-addin/issues/31</linkUri>
28+
</externalLink> Provide a generic document events handler
29+
</para>
30+
</listItem>
31+
</list>
32+
</content>
33+
</section>
34+
35+
<relatedTopics>
36+
<link xlink:href="version-history" />
37+
</relatedTopics>
38+
39+
</developerConceptualDocument>
40+
</topic>

‎HelpDoc/ContentLayout.content

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
<Topic id="v0-4-1" visible="True" title="Version 0.4.1" />
3030
<Topic id="v0-7-0" visible="True" title="Version 0.7.0" />
3131
<Topic id="v0-7-5" visible="True" title="Version 0.7.5" />
32-
<Topic id="v0-7-6" visible="True" isSelected="true" title="Version 0.7.6" />
32+
<Topic id="v0-7-6" visible="True" title="Version 0.7.6" />
33+
<Topic id="v0-8-0" visible="True" isSelected="true" title="Version 0.8.0" />
3334
</Topic>
3435
</Topics>

‎HelpDoc/HelpDoc.shfbproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@
106106
<None Include="Content\VersionHistory\v0.7.0.aml" />
107107
<None Include="Content\VersionHistory\v0.7.5.aml" />
108108
<None Include="Content\VersionHistory\v0.7.6.aml" />
109+
<None Include="Content\VersionHistory\v0.8.0.aml" />
109110
<None Include="Content\VersionHistory\VersionHistory.aml" />
110111
<None Include="Content\Welcome.aml" />
111112
<None Include="Content\VersionHistory\v0.3.0.aml" />

0 commit comments

Comments
 (0)