Skip to content
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.

Sign up for GitHub

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

Add doxygen markup for ignoring internal classes #3

Merged
1 commit merged into from
Sep 8, 2015
+2,469 −3
Merged

Add doxygen markup for ignoring internal classes #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Apex7000_BillValidator_Test/obj/
Apex7000_BillValidator/bin/
API_Test/bin/
API_Test/obj/
docs/
4 changes: 3 additions & 1 deletion Apex7000_BillValidator/Apex7000_BillValidator.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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">
Expand Down
5 changes: 4 additions & 1 deletion Apex7000_BillValidator/MasterCodex.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
3 changes: 2 additions & 1 deletion Apex7000_BillValidator/Serial/PortException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

namespace PTI.Serial
{
/// \internal
internal enum ExceptionTypes
{
Timeout,
Expand All @@ -11,7 +12,7 @@ internal enum ExceptionTypes
AccessError
}


/// \internal
[SerializableAttribute]
internal class PortException : Exception, ISerializable
{
Expand Down
1 change: 1 addition & 0 deletions Apex7000_BillValidator/Serial/SerialPortFixer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

namespace PTI.Serial
{
/// \internal
internal class SerialPortFixer : IDisposable
{
[EnvironmentPermissionAttribute(SecurityAction.LinkDemand, Unrestricted = true)]
Expand Down
1 change: 1 addition & 0 deletions Apex7000_BillValidator/Serial/StrongPort.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
1 change: 1 addition & 0 deletions Apex7000_BillValidator/SlaveCodex.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading