Merge pull request #3 from PyramidTechnologies/java_rewrite

Add doxygen markup for ignoring internal classes
PyramidTechnologies · Sep 8, 2015 · d2bb347 · d2bb347
2 parents 68e690a + cd5ff23
commit d2bb347
Show file tree

Hide file tree

Showing 9 changed files with 2,469 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ Apex7000_BillValidator_Test/obj/
 Apex7000_BillValidator/bin/
 API_Test/bin/
 API_Test/obj/
+docs/
diff --git a/Apex7000_BillValidator/Apex7000_BillValidator.csproj b/Apex7000_BillValidator/Apex7000_BillValidator.csproj
@@ -21,7 +21,8 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
-    <DocumentationFile>bin\Debug\Apex7000_BillValidator.XML</DocumentationFile>
+    <DocumentationFile>
+    </DocumentationFile>
     <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
     <GenerateSerializationAssemblies>Off</GenerateSerializationAssemblies>
   </PropertyGroup>
@@ -32,6 +33,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\Apex7000_BillValidator.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="log4net, Version=1.2.13.0, Culture=neutral, PublicKeyToken=669e0ddf0bb1aa2a, processorArchitecture=MSIL">

diff --git a/Apex7000_BillValidator/MasterCodex.cs b/Apex7000_BillValidator/MasterCodex.cs
@@ -1,7 +1,10 @@
 
 namespace Apex7000_BillValidator
 {
-    class MasterCodex
+    /// <summary>
+    /// \internal
+    /// </summary>
+    internal class MasterCodex
     {
         // Mask out reserved and ignored bits
         private static MasterMessage relevanceMask = (MasterMessage)0xFE7F;

diff --git a/Apex7000_BillValidator/Serial/PortException.cs b/Apex7000_BillValidator/Serial/PortException.cs
@@ -3,6 +3,7 @@
 
 namespace PTI.Serial
 {
+    /// \internal
     internal enum ExceptionTypes
     {
         Timeout,
@@ -11,7 +12,7 @@ internal enum ExceptionTypes
         AccessError
     }
 
-
+    /// \internal
     [SerializableAttribute]
     internal class PortException : Exception, ISerializable
     {

diff --git a/Apex7000_BillValidator/Serial/SerialPortFixer.cs b/Apex7000_BillValidator/Serial/SerialPortFixer.cs
@@ -22,6 +22,7 @@
 
 namespace PTI.Serial
 {
+    /// \internal
     internal class SerialPortFixer : IDisposable
     {
         [EnvironmentPermissionAttribute(SecurityAction.LinkDemand, Unrestricted = true)]

diff --git a/Apex7000_BillValidator/Serial/StrongPort.cs b/Apex7000_BillValidator/Serial/StrongPort.cs
@@ -12,6 +12,7 @@ namespace PTI.Serial
 {
 
     // Wrapper around SerialPort
+    // \internal
     internal class StrongPort : ICommPort
     {
         private static readonly ILog log = LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

diff --git a/Apex7000_BillValidator/SlaveCodex.cs b/Apex7000_BillValidator/SlaveCodex.cs
@@ -5,6 +5,7 @@ namespace Apex7000_BillValidator
     /// <summary>
     /// Used internally to quickly translate between bytes and the string meaning
     /// </summary>
+    /// \internal
     internal class SlaveCodex
     {
         private static SlaveMessage stateMask = (SlaveMessage)0x40C2F;