Update Documenration

Update the documentation of the code to include author headers, a read me file and a license file.
DGH2112 · Dec 17, 2016 · 29a83b8 · 29a83b8
1 parent 4aac2b9
commit 29a83b8
Show file tree

Hide file tree

Showing 17 changed files with 202 additions and 15 deletions.
diff --git a/.gitignore b/.gitignore
@@ -89,3 +89,4 @@ $RECYCLE.BIN/
 *.stat
 *.#0*
 *.~*~
+*.~dsk
diff --git a/DLLs/CPPOTATemplateXE101.cbproj b/DLLs/CPPOTATemplateXE101.cbproj
@@ -153,6 +153,8 @@
             <Suffix>_0</Suffix>
             <BuildOrder>5</BuildOrder>
         </ResourceCompile>
+        <None Include="..\License.md"/>
+        <None Include="..\README.md"/>
         <CppCompile Include="..\Source\CPPOTATemplateAboutBoxPlugin.cpp">
             <DependentOn>..\Source\CPPOTATemplateAboutBoxPlugin.h</DependentOn>
             <BuildOrder>6</BuildOrder>
@@ -298,7 +300,16 @@
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>
-                <DeployClass Name="ProjectiOSDeviceResourceRules"/>
+                <DeployClass Name="DependencyModule">
+                    <Platform Name="Win32">
+                        <Operation>0</Operation>
+                        <Extensions>.dll;.bpl</Extensions>
+                    </Platform>
+                    <Platform Name="OSX32">
+                        <Operation>1</Operation>
+                        <Extensions>.dylib</Extensions>
+                    </Platform>
+                </DeployClass>
                 <DeployClass Name="ProjectOSXResource">
                     <Platform Name="OSX32">
                         <RemoteDir>Contents\Resources</RemoteDir>
@@ -637,16 +648,7 @@
                         <Operation>1</Operation>
                     </Platform>
                 </DeployClass>
-                <DeployClass Name="DependencyModule">
-                    <Platform Name="Win32">
-                        <Operation>0</Operation>
-                        <Extensions>.dll;.bpl</Extensions>
-                    </Platform>
-                    <Platform Name="OSX32">
-                        <Operation>1</Operation>
-                        <Extensions>.dylib</Extensions>
-                    </Platform>
-                </DeployClass>
+                <DeployClass Name="ProjectiOSDeviceResourceRules"/>
                 <ProjectRoot Platform="iOSDevice64" Name="$(PROJECTNAME).app"/>
                 <ProjectRoot Platform="Win64" Name="$(PROJECTNAME)"/>
                 <ProjectRoot Platform="iOSDevice32" Name="$(PROJECTNAME).app"/>

diff --git a/License.md b/License.md
@@ -0,0 +1,34 @@
+# C++ Open Tools API Template
+
+Author: David Hoyle
+
+Version: 1.0
+
+Date: 17 Dec 2016
+
+Web Page: http://www.davidghoyle.co.uk/WordPress/?page_id=1468
+
+
+
+The code contain in the project can be used as an aid to learning and used
+to compile the project for your personal use. The code can be modified for
+your personel use however you should retain the headers identifying the
+original author and should not be publshed without the author's consent.
+
+The code should not be used verbatum in any other projects but the essense / ideas
+in the code can be reused in your applications.
+
+This code should not be published without the author's prior consent nor should
+the code be used in a commercial product with out the author's consent.
+
+
+
+regards
+
+David Hoyle (c) 17 Dec 2016
+
+davidghoyle@gmail.com
+
+Web Page: http://www.davidghoyle.co.uk/WordPress/?page_id=1468
+
+Season's Fall Music
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# C++ Open Tools API Template
+
+Author: David Hoyle
+
+Version: 1.0
+
+Date: 17 Dec 2016
+
+Web Page: http://www.davidghoyle.co.uk/WordPress/?page_id=1468
+
+
+
+Description
+
+This is a RAD Studio wizard / expert / plug-in which example in C++ Builder
+to demonstrate how to build Open Tools API projects for the RAD Studio IDEs
+with C++.
+
+At the moment the project only implements some basic Open Tool APIs examples:
+ * Splash Screen;
+ * About Box;
+ * IDE Notifier;
+ * IDE Options frame.
+
+Eventually this project will have the same capabilities as its Pascal cousin
+and be able to create the template files for a C++ Builder OTA project.
diff --git a/Source/CPPOTATemplateAboutBoxPlugin.h b/Source/CPPOTATemplateAboutBoxPlugin.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains two functions for adding an about box entry to the RAD Studio IDE
+  about dialogue and also removing the entry.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateAboutBoxPluginH
 #define CPPOTATemplateAboutBoxPluginH
 #endif

diff --git a/Source/CPPOTATemplateAddinOptions.h b/Source/CPPOTATemplateAddinOptions.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains a class which implements the INTAAddInOptions interface than handles the
+  insertion of the options frame into the RAD Studio IDEs options dialogue.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2017
+
+**/
 #ifndef CPPOTATemplateAddinOptionsH
 #define CPPOTATemplateAddinOptionsH
 

diff --git a/Source/CPPOTATemplateAppOptions.h b/Source/CPPOTATemplateAppOptions.h
@@ -1,3 +1,12 @@
+/**
+
+  This module contains a class which handles ALL the applications options.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2017
+
+**/
 #ifndef CPPOTATemplateAppOptionsH
 #define CPPOTATemplateAppOptionsH
 

diff --git a/Source/CPPOTATemplateAppOptionsFrame.dfm b/Source/CPPOTATemplateAppOptionsFrame.dfm
@@ -15,7 +15,6 @@ object frameAppOptions: TframeAppOptions
     Anchors = [akLeft, akTop, akRight]
     Caption = '&Enabled'
     TabOrder = 0
-    ExplicitWidth = 549
   end
   object gbxAutoSaveOptions: TGroupBox
     Left = 3
@@ -25,8 +24,6 @@ object frameAppOptions: TframeAppOptions
     Anchors = [akLeft, akTop, akRight, akBottom]
     Caption = 'Auto Save &Options'
     TabOrder = 1
-    ExplicitWidth = 549
-    ExplicitHeight = 313
     object lblInterval: TLabel
       Left = 16
       Top = 32
@@ -42,7 +39,7 @@ object frameAppOptions: TframeAppOptions
       Height = 21
       ReadOnly = True
       TabOrder = 0
-      Text = '0'
+      Text = '10'
     end
     object udInterval: TUpDown
       Left = 145
@@ -52,6 +49,7 @@ object frameAppOptions: TframeAppOptions
       Associate = edtInterval
       Min = 10
       Max = 3600
+      Position = 10
       TabOrder = 1
     end
     object chkPrompt: TCheckBox

diff --git a/Source/CPPOTATemplateAppOptionsFrame.h b/Source/CPPOTATemplateAppOptionsFrame.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains a class which represents an options frame for inserting into the
+  RAD Studio IDEs options dialogue.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateAppOptionsFrameH
 #define CPPOTATemplateAppOptionsFrameH
 

diff --git a/Source/CPPOTATemplateConstants.h b/Source/CPPOTATemplateConstants.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains a number of constants that are used in various aspeccts of the
+  application.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2017
+
+**/
 #ifndef CPPOTATemplateConstantsH
 #define CPPOTATemplateConstantsH
 #endif

diff --git a/Source/CPPOTATemplateFunctions.h b/Source/CPPOTATemplateFunctions.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains a function to get the wizard / expert / plug-ins build information for use
+  in the splash screen and about box entry.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateFunctionsH
 #define CPPOTATemplateFunctionsH
 #endif

diff --git a/Source/CPPOTATemplateIDENotifier.h b/Source/CPPOTATemplateIDENotifier.h
@@ -1,3 +1,14 @@
+/**
+
+  This module contains a class which implements the IOTAIDENotifier, IOTAIDENotifier50 and
+  IOTAIDENotifier80 interfaces for capturing file notificationevents and compiler events in the
+  RAD Studio IDE.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateIDENotifierH
 #define CPPOTATemplateIDENotifierH
 

diff --git a/Source/CPPOTATemplateMacros.h b/Source/CPPOTATemplateMacros.h
@@ -1,3 +1,13 @@
+/**
+
+  This module contains macros for use through the application to help with casting Delphi interfaces
+  and getting a reference to the BorlandIDEServices variable.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateMacrosH
 #define CPPOTATemplateMacrosH
 

diff --git a/Source/CPPOTATemplateMainWizard.h b/Source/CPPOTATemplateMainWizard.h
@@ -1,3 +1,16 @@
+/**
+
+  This module contains a class that implements the IOTAWizard and IOTAMenuWizard interfaces
+  to provide a main wizard interfaces for this OTA project which installs and Open Tools
+  API wizard / expert / plug-in into the RAD Studio IDE.
+
+  This clas manages ALL objects created and used by this application.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateMainWizardH
 #define CPPOTATemplateMainWizardH
 

diff --git a/Source/CPPOTATemplateNotifierObject.h b/Source/CPPOTATemplateNotifierObject.h
@@ -1,3 +1,14 @@
+/**
+
+  This module contains a class which immplements the IOTANotifier interface (which in turn
+  implements IInterface) to act as a base class for all the objects in the application so that
+  they can all output notifications to the RAD Studio IDE message view.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateNotifierObjectH
 #define CPPOTATemplateNotifierObjectH
 

diff --git a/Source/CPPOTATemplatePkgDLLInit.h b/Source/CPPOTATemplatePkgDLLInit.h
@@ -1,3 +1,14 @@
+/**
+
+  This module contains function to either regsiter the main wizard with the RAD Studio IDE
+  when the wzizard / expert / plugin is loaded as a package or register the application with the
+  IDE when loaded as a DLL.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplatePkgDLLInitH
 #define CPPOTATemplatePkgDLLInitH
 #endif

diff --git a/Source/CPPOTATemplateSplashScreen.h b/Source/CPPOTATemplateSplashScreen.h
@@ -1,3 +1,14 @@
+/**
+
+  This module contains a function to add a splash screen to the RAD Studio IDE on startup.
+  Note: This currently will only work with packages due to the inability to blind the DesignIDE
+  package to the DLL.
+
+  @Author  David Hoyle
+  @Version 1.0
+  @Date    17 Dec 2016
+
+**/
 #ifndef CPPOTATemplateSplashScreenH
 #define CPPOTATemplateSplashScreenH
 #endif