include/clang-c/Index.h

612  * \brief Describes the severity of a particular diagnostic.
616    * \brief A diagnostic that has been suppressed, e.g., by a command-line
622    * \brief This diagnostic is a note that should be attached to the
623    * previous (non-note) diagnostic.
628    * \brief This diagnostic indicates suspicious code that may not be
634    * \brief This diagnostic indicates that the code is ill-formed.
639    * \brief This diagnostic indicates that the code is ill-formed such
647  * \brief A single diagnostic, containing the diagnostic's severity,
663  * \brief Retrieve a diagnostic associated with the given CXDiagnosticSet.
666  * \param Index the zero-based diagnostic number to retrieve.
668  * \returns the requested diagnostic. This diagnostic must be freed
741  * \brief Retrieve a diagnostic associated with the given translation unit.
744  * \param Index the zero-based diagnostic number to retrieve.
746  * \returns the requested diagnostic. This diagnostic must be freed
762  * \brief Destroy a diagnostic.
775    * diagnostic was located.
778    * (optionally) column to which the diagnostic refers. For example,
790    * diagnostic, also include the column number.
798    * diagnostic, also include information about source ranges in a
807    * \brief Display the option name associated with this diagnostic, if any.
810    * after the diagnostic text. This option corresponds to the clang flag
816    * \brief Display the category number associated with this diagnostic, if any.
818    * The category number is displayed within brackets after the diagnostic text.
825    * \brief Display the category name associated with this diagnostic, if any.
827    * The category name is displayed within brackets after the diagnostic text.
835  * \brief Format the given diagnostic in a manner that is suitable for display.
837  * This routine will format the given diagnostic to a string, rendering
838  * the diagnostic according to the various options given. The
842  * \param Diagnostic The diagnostic to print.
844  * \param Options A set of options that control the diagnostic display,
847  * \returns A new string containing for formatted diagnostic.
862  * \brief Determine the severity of the given diagnostic.
868  * \brief Retrieve the source location of the given diagnostic.
871  * displaying the diagnostic on the command line.
876  * \brief Retrieve the text of the given diagnostic.
882  * diagnostic.
884  * \param Diag The diagnostic to be queried.
887  * diagnostic (if any).
896  * \brief Retrieve the category number for this diagnostic.
900  * retrieves the category number for the given diagnostic.
902  * \returns The number of the category that contains this diagnostic, or zero
903  * if this diagnostic is uncategorized.
908  * \brief Retrieve the name of a particular diagnostic category.  This
912  * \param Category A diagnostic category number, as returned by
915  * \returns The name of the given diagnostic category.
921  * \brief Retrieve the diagnostic category text for a given diagnostic.
923  * \returns The text of the given diagnostic category.
929  * diagnostic.
934  * \brief Retrieve a source range associated with the diagnostic.
936  * A diagnostic's source ranges highlight important elements in the source
940  * \param Diagnostic the diagnostic whose range is being extracted.
951  * given diagnostic.
968  * \param Diagnostic The diagnostic whose fix-its are being queried.
5012  * \brief Retrieve a diagnostic associated with the given code completion.
5015  * \param Index the zero-based diagnostic number to retrieve.
5017  * \returns the requested diagnostic. This diagnostic must be freed
5598    * \brief Called at the end of indexing; passes the complete diagnostic set.
5600   void (*diagnostic)(CXClientData client_data,