Skip to content

Commit cdbd4e6

Browse files
authored
Update IDxcVersionInfo header docs to be more accurate (#8066)
Previous docs were....misleading at best. This change makes them more accurate.
1 parent 745a694 commit cdbd4e6

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

include/dxc/dxcapi.h

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,20 +1061,21 @@ static const UINT32 DxcVersionInfoFlags_Internal =
10611061
2; // Internal Validator (non-signing)
10621062

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

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

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

0 commit comments

Comments
 (0)