Skip to content

Commit eb72e5f

Browse files
committed
Added condition commands so doxygen will not generate a documentation entry for 'private protected' members
1 parent 46f8ffd commit eb72e5f

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

src/WGet.NET/Abstractions/WinGetInfoEntry.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ public virtual bool IsEmpty
6262
}
6363
}
6464

65+
// \cond PRIVATE
6566
private protected readonly string _entryName;
6667
private protected readonly string _rawContent;
6768
private protected readonly bool _hasShortenedContent;
@@ -78,6 +79,7 @@ private protected WinGetInfoEntry(string entryName, string rawContent, bool hasS
7879
_rawContent = rawContent;
7980
_hasShortenedContent = hasShortenedContent;
8081
}
82+
// \endcond
8183

8284
/// <inheritdoc/>
8385
public override string ToString()

src/WGet.NET/Components/WinGet.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,7 @@ public async Task<WinGetInfo> GetInfoAsync()
658658
//---------------------------------------------------------------------------------------------
659659

660660
//---Protected Functions-----------------------------------------------------------------------
661+
// \cond PRIVATE
661662
/// <summary>
662663
/// Checks if the installed WinGet version is between the given versions or the same.
663664
/// </summary>
@@ -669,7 +670,7 @@ public async Task<WinGetInfo> GetInfoAsync()
669670
/// <returns>
670671
/// <see langword="true"/> if the installed WinGet version matches the check, or <see langword="false"/> if not.
671672
/// </returns>
672-
protected bool CheckWinGetVersion(Version minVersion, Version? maxVersion = null)
673+
private protected bool CheckWinGetVersion(Version minVersion, Version? maxVersion = null)
673674
{
674675
Version winGetVersion = Version;
675676
if ((winGetVersion.Major >= minVersion.Major && winGetVersion.Minor >= minVersion.Minor &&
@@ -744,6 +745,7 @@ private protected async Task<ProcessResult> ExecuteAsync(string args, bool needs
744745

745746
return await _processManager.ExecuteWingetProcessAsync(args);
746747
}
748+
// \endcond
747749
//---------------------------------------------------------------------------------------------
748750

749751
//---Other-------------------------------------------------------------------------------------

src/WGet.NET/Data/WinGetPackage.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ public bool IsEmpty
159159
}
160160
}
161161

162+
// \cond PRIVATE
162163
private protected readonly string _name;
163164
private protected readonly string _id;
164165
private protected readonly string _versionString;
@@ -168,6 +169,7 @@ public bool IsEmpty
168169
private protected readonly string _sourceName;
169170

170171
private protected readonly bool _hasShortenedId = false;
172+
// \endcond
171173

172174
/// <summary>
173175
/// Initializes a new instance of the <see cref="WGetNET.WinGetPackage"/> class.

0 commit comments

Comments
 (0)