{"id":32338,"date":"2023-06-13T21:52:38","date_gmt":"2023-06-13T21:52:38","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/cppblog\/?p=32338"},"modified":"2023-06-14T17:45:57","modified_gmt":"2023-06-14T17:45:57","slug":"improved-doxygen-overload-resolution","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/improved-doxygen-overload-resolution\/","title":{"rendered":"Improved Doxygen Overload Resolution"},"content":{"rendered":"<p><span data-contrast=\"none\">We are excited to announce an enhanced Doxygen Comment Support for C++ in <a href=\"https:\/\/visualstudio.microsoft.com\/vs\/preview\/\" target=\"_blank\" rel=\"noopener\">Visual Studio 17.7 Preview 2<\/a>. T<\/span><span style=\"font-size: 1rem; text-align: var(--bs-body-text-align);\" data-contrast=\"none\">o start using this feature, ensure to update to the latest version of Visual Studio Preview.\u00a0<\/span><span style=\"font-size: 1rem; text-align: var(--bs-body-text-align);\" data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<p><div  class=\"d-flex justify-content-center\"><a class=\"cta_button_link btn-primary mb-24\" href=\"https:\/\/visualstudio.microsoft.com\/vs\/preview\/\" target=\"_blank\">Download Visual Studio 2022 Preview<\/a><\/div><\/p>\n<h3><span class=\"TextRun SCXW241283891 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW241283891 BCX8\" data-ccp-parastyle=\"heading 1\">Improved <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW241283891 BCX8\" data-ccp-parastyle=\"heading 1\">Doxygen<\/span><span class=\"NormalTextRun SCXW241283891 BCX8\" data-ccp-parastyle=\"heading 1\"> overload resolution<\/span><\/span><span class=\"EOP SCXW241283891 BCX8\" data-ccp-props=\"{&quot;134245418&quot;:true,&quot;134245529&quot;:true,&quot;201341983&quot;:0,&quot;335559738&quot;:240,&quot;335559739&quot;:0,&quot;335559740&quot;:259}\">\u00a0<\/span><\/h3>\n<p><span class=\"TextRun SCXW110465108 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SpellingErrorV2Themed SCXW110465108 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW110465108 BCX8\"> comment support has been enhanced to improve the visibility and consistency of shared <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW110465108 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW110465108 BCX8\"> comments across all overloads of a function. Previously, these comments were only displayed in Quick Info for the first overload<\/span><span class=\"NormalTextRun SCXW110465108 BCX8\">,<\/span><span class=\"NormalTextRun SCXW110465108 BCX8\"> as <\/span><span class=\"NormalTextRun SCXW110465108 BCX8\">shown <\/span><span class=\"NormalTextRun SCXW110465108 BCX8\">below<\/span><span class=\"NormalTextRun SCXW110465108 BCX8\">.<\/span><\/span><span class=\"EOP SCXW110465108 BCX8\" data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/cppblog\/wp-content\/uploads\/sites\/9\/2023\/06\/Doxygen_Before_Improvement.gif\"><img decoding=\"async\" class=\"aligncenter wp-image-32339\" src=\"https:\/\/devblogs.microsoft.com\/cppblog\/wp-content\/uploads\/sites\/9\/2023\/06\/Doxygen_Before_Improvement.gif\" alt=\"Doxygen Comment Before Improvement\" width=\"412\" height=\"503\" \/><\/a><span class=\"TextRun SCXW169773779 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW169773779 BCX8\">W<\/span><span class=\"NormalTextRun SCXW169773779 BCX8\">ith th<\/span><span class=\"NormalTextRun SCXW169773779 BCX8\">is feature <\/span><span class=\"NormalTextRun SCXW169773779 BCX8\">improvement, the shared <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW169773779 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW169773779 BCX8\"> comment will now appear in Quick Info of all other overloads as well.<\/span><span class=\"NormalTextRun SCXW169773779 BCX8\"> This enhancement is <\/span><span class=\"NormalTextRun SCXW169773779 BCX8\">demonstrated<\/span><span class=\"NormalTextRun SCXW169773779 BCX8\"> below.<\/span><\/span><span class=\"EOP SCXW169773779 BCX8\" data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<p><a href=\"https:\/\/devblogs.microsoft.com\/cppblog\/wp-content\/uploads\/sites\/9\/2023\/06\/Doxygen_After_Improvement.gif\"><img decoding=\"async\" class=\"aligncenter wp-image-32343\" src=\"https:\/\/devblogs.microsoft.com\/cppblog\/wp-content\/uploads\/sites\/9\/2023\/06\/Doxygen_After_Improvement.gif\" alt=\"Doxygen Comment After Improvement\" width=\"421\" height=\"486\" \/><\/a><span class=\"TextRun SCXW170559910 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW170559910 BCX8\">In cases where the <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW170559910 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW170559910 BCX8\"> comment is not directly positioned above an overload but <\/span><span class=\"NormalTextRun SCXW170559910 BCX8\">is applicable<\/span><span class=\"NormalTextRun SCXW170559910 BCX8\"> to that overload, the Quick Info explicitly <\/span><span class=\"NormalTextRun SCXW170559910 BCX8\">indicates<\/span><span class=\"NormalTextRun SCXW170559910 BCX8\"> this by including the text &#8220;Documentation from another overload.&#8221; This ensures that you are aware that the information comes from a different overload <\/span><span class=\"NormalTextRun SCXW170559910 BCX8\">of <\/span><span class=\"NormalTextRun SCXW170559910 BCX8\">the function.<\/span><\/span><span class=\"EOP SCXW170559910 BCX8\" data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<p><span class=\"TextRun SCXW2752033 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW2752033 BCX8\">Additionally, the <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW2752033 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW2752033 BCX8\"> comment support now <\/span><span class=\"NormalTextRun SCXW2752033 BCX8\">provides<\/span><span class=\"NormalTextRun SCXW2752033 BCX8\"> improved visibility for unused parameters. The Quick Info categorizes these unused parameters under the &#8220;Unused Parameters&#8221; section, allowing developers to easily <\/span><span class=\"NormalTextRun SCXW2752033 BCX8\">identify<\/span><span class=\"NormalTextRun SCXW2752033 BCX8\"> which parameters are mentioned in the <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW2752033 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW2752033 BCX8\"> comment but are not <\/span><span class=\"NormalTextRun SCXW2752033 BCX8\">utilized<\/span><span class=\"NormalTextRun SCXW2752033 BCX8\"> in the associated overload.\u00a0<\/span><\/span><span class=\"EOP SCXW2752033 BCX8\" data-ccp-props=\"{&quot;201341983&quot;:0,&quot;335559739&quot;:160,&quot;335559740&quot;:259}\">\u00a0<\/span><\/p>\n<h3><span class=\"TextRun SCXW244717510 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW244717510 BCX8\" data-ccp-parastyle=\"heading 1\">Send us your feedback!<\/span><\/span><span class=\"EOP SCXW244717510 BCX8\" data-ccp-props=\"{&quot;134245418&quot;:true,&quot;134245529&quot;:true,&quot;201341983&quot;:0,&quot;335559738&quot;:240,&quot;335559739&quot;:0,&quot;335559740&quot;:259}\">\u00a0<\/span><\/h3>\n<p><span class=\"TextRun SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\">Try out <\/span><span class=\"NormalTextRun SCXW212408048 BCX8\">Improved <\/span><span class=\"NormalTextRun SpellingErrorV2Themed SCXW212408048 BCX8\">Doxygen<\/span><span class=\"NormalTextRun SCXW212408048 BCX8\"> Overload Resolution by downloading the\u00a0<a href=\"https:\/\/visualstudio.microsoft.com\/vs\/preview\/\" target=\"_blank\" rel=\"noopener\">latest version of Visual Studio Preview<\/a>. <\/span><\/span><span class=\"TextRun SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\">We value your feedback, as it <\/span><span class=\"NormalTextRun SCXW212408048 BCX8\">greatly influences<\/span><span class=\"NormalTextRun SCXW212408048 BCX8\"> our development. Please share your thoughts in the comments below, on\u00a0<a href=\"https:\/\/developercommunity.visualstudio.com\/cpp\" target=\"_blank\" rel=\"noopener\">Developer Community<\/a><\/span><\/span><span class=\"TextRun SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\">, or reach out to us on Twitter\u202f(<\/span><\/span><a class=\"Hyperlink SCXW212408048 BCX8\" href=\"https:\/\/twitter.com\/visualc\" target=\"_blank\" rel=\"noreferrer noopener\"><span class=\"TextRun Underlined SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\" data-ccp-charstyle=\"Hyperlink\">@VisualC<\/span><\/span><\/a><span class=\"TextRun SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\">) or via email at <\/span><\/span><a class=\"Hyperlink SCXW212408048 BCX8\" href=\"mailto:visualcpp@microsoft.com\" target=\"_blank\" rel=\"noreferrer noopener\"><span class=\"TextRun Underlined SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\" data-ccp-charstyle=\"Hyperlink\">visualcpp@microsoft.com<\/span><\/span><\/a><span class=\"TextRun SCXW212408048 BCX8\" lang=\"EN-US\" xml:lang=\"EN-US\" data-contrast=\"none\"><span class=\"NormalTextRun SCXW212408048 BCX8\">. We highly appreciate your inputs!<\/span><\/span><\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>We are excited to announce an enhanced Doxygen Comment Support for C++ in Visual Studio 17.7 Preview 2. To start using this feature, ensure to update to the latest version of Visual Studio Preview.\u00a0\u00a0 Improved Doxygen overload resolution\u00a0 Doxygen comment support has been enhanced to improve the visibility and consistency of shared Doxygen comments across [&hellip;]<\/p>\n","protected":false},"author":96741,"featured_media":35994,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-32338","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus"],"acf":[],"blog_post_summary":"<p>We are excited to announce an enhanced Doxygen Comment Support for C++ in Visual Studio 17.7 Preview 2. To start using this feature, ensure to update to the latest version of Visual Studio Preview.\u00a0\u00a0 Improved Doxygen overload resolution\u00a0 Doxygen comment support has been enhanced to improve the visibility and consistency of shared Doxygen comments across [&hellip;]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/32338","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/96741"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=32338"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/32338\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/35994"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=32338"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=32338"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=32338"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}