This is an archive of the discontinued LLVM Phabricator instance.

Differential D146275

[libclang] Fix documentation; NFC
ClosedPublic

Authored by vedgy on Mar 17 2023, 1:24 AM.

Download Raw Diff

Details

Reviewers

aaron.ballman

Commits

rG2d91b0dae0a9: [libclang] Fix documentation; NFC

Summary

Fixes cc929590ad305f0d068709c7c7999f5fc6118dc9. The
CXIndexOptions::GlobalOptions data member has been replaced with the two
CXChoice data members during code review.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

vedgy created this revision.Mar 17 2023, 1:24 AM

Herald added a project: Restricted Project. · View Herald TranscriptMar 17 2023, 1:24 AM

Herald added subscribers: mikhail.ramalho, arphaman. · View Herald Transcript

vedgy requested review of this revision.Mar 17 2023, 1:24 AM

Herald added a project: Restricted Project. · View Herald TranscriptMar 17 2023, 1:24 AM

Herald added a subscriber: cfe-commits. · View Herald Transcript

Noticed the mistake while reviewing the generated documentation.

Harbormaster completed remote builds in B220011: Diff 506002.Mar 17 2023, 2:21 AM

LGTM, good catch!

This revision is now accepted and ready to land.Mar 17 2023, 5:39 AM

This revision was landed with ongoing or failed builds.Mar 17 2023, 5:40 AM

Closed by commit rG2d91b0dae0a9: [libclang] Fix documentation; NFC (authored by vedgy, committed by aaron.ballman). · Explain Why

This revision was automatically updated to reflect the committed changes.

aaron.ballman added a commit: rG2d91b0dae0a9: [libclang] Fix documentation; NFC.

Revision Contents

Path

Size

clang/

include/

clang-c/

Index.h

4 lines

Diff 506051

clang/include/clang-c/Index.h

	Show First 20 Lines • Show All 439 Lines • ▼ Show 20 Lines
	* \sa clang_createIndex()			* \sa clang_createIndex()
	*/			*/
	CINDEX_LINKAGE CXIndex			CINDEX_LINKAGE CXIndex
	clang_createIndexWithOptions(const CXIndexOptions *options);			clang_createIndexWithOptions(const CXIndexOptions *options);

	/**			/**
	* Sets general options associated with a CXIndex.			* Sets general options associated with a CXIndex.
	*			*
	* This function is DEPRECATED. Set CXIndexOptions::GlobalOptions and call			* This function is DEPRECATED. Set
				* CXIndexOptions::ThreadBackgroundPriorityForIndexing and/or
				* CXIndexOptions::ThreadBackgroundPriorityForEditing and call
	* clang_createIndexWithOptions() instead.			* clang_createIndexWithOptions() instead.
	*			*
	* For example:			* For example:
	* \code			* \code
	* CXIndex idx = ...;			* CXIndex idx = ...;
	* clang_CXIndex_setGlobalOptions(idx,			* clang_CXIndex_setGlobalOptions(idx,
	* clang_CXIndex_getGlobalOptions(idx) \|			* clang_CXIndex_getGlobalOptions(idx) \|
	* CXGlobalOpt_ThreadBackgroundPriorityForIndexing);			* CXGlobalOpt_ThreadBackgroundPriorityForIndexing);
	▲ Show 20 Lines • Show All 6,063 Lines • Show Last 20 Lines