Skip to content

Update IDxcVersionInfo header docs to be more accurate #8066

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

Open
damyanp wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −8
Open

Update IDxcVersionInfo header docs to be more accurate #8066

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
17 changes: 9 additions & 8 deletions include/dxc/dxcapi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1061,20 +1061,21 @@ static const UINT32 DxcVersionInfoFlags_Internal =
2; // Internal Validator (non-signing)

CROSS_PLATFORM_UUIDOF(IDxcVersionInfo, "b04f5b50-2059-4f12-a8ff-a1e0cde1cc7e")
/// \brief PDB Version information.
/// \brief Version information.
///
/// Use IDxcPdbUtils2::GetVersionInfo to obtain an instance of this.
/// This interface provides version information for the object that implements
/// it and can be obtained using QueryInterface.
struct IDxcVersionInfo : public IUnknown {
virtual HRESULT STDMETHODCALLTYPE GetVersion(_Out_ UINT32 *pMajor,
_Out_ UINT32 *pMinor) = 0;
virtual HRESULT STDMETHODCALLTYPE GetFlags(_Out_ UINT32 *pFlags) = 0;
};

CROSS_PLATFORM_UUIDOF(IDxcVersionInfo2, "fb6904c4-42f0-4b62-9c46-983af7da7c83")
/// \brief PDB Version Information.
/// \brief Version Information.
///
/// Use IDxcPdbUtils2::GetVersionInfo to obtain a IDxcVersionInfo interface, and
/// then use QueryInterface to obtain an instance of this interface from it.
/// This interface provides version information for the object that implements
/// it and can be obtained using QueryInterface.
struct IDxcVersionInfo2 : public IDxcVersionInfo {
virtual HRESULT STDMETHODCALLTYPE GetCommitInfo(
_Out_ UINT32 *pCommitCount, ///< The total number commits.
Expand All @@ -1084,10 +1085,10 @@ struct IDxcVersionInfo2 : public IDxcVersionInfo {
};

CROSS_PLATFORM_UUIDOF(IDxcVersionInfo3, "5e13e843-9d25-473c-9ad2-03b2d0b44b1e")
/// \brief PDB Version Information.
/// \brief Version Information.
///
/// Use IDxcPdbUtils2::GetVersionInfo to obtain a IDxcVersionInfo interface, and
/// then use QueryInterface to obtain an instance of this interface from it.
/// This interface provides version information for the object that implements
/// it and can be obtained using QueryInterface.
struct IDxcVersionInfo3 : public IUnknown {
virtual HRESULT STDMETHODCALLTYPE GetCustomVersionString(
_Outptr_result_z_ char *
Expand Down
Loading