-
Notifications
You must be signed in to change notification settings - Fork 10.8k
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.
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
[llvm][vfs] Remove blank comment after \endverbatim doxygen command #83240
Conversation
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write If you have received no comments on your PR for a week, you can request a review If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
@llvm/pr-subscribers-llvm-support Author: None (yelleyee) ChangesBlank comment line afer \endverbatim malfunctions the doxygen parser. Screenshot is attached below Full diff: https://github.com/llvm/llvm-project/pull/83240.diff 1 Files Affected:
diff --git a/llvm/include/llvm/Support/VirtualFileSystem.h b/llvm/include/llvm/Support/VirtualFileSystem.h
index 1a5ea677db74da..ef1fac92c2fa4a 100644
--- a/llvm/include/llvm/Support/VirtualFileSystem.h
+++ b/llvm/include/llvm/Support/VirtualFileSystem.h
@@ -672,7 +672,6 @@ class RedirectingFileSystemParser;
/// ]
/// }
/// \endverbatim
-///
/// The roots may be absolute or relative. If relative they will be made
/// absolute against either current working directory or the directory where
/// the Overlay YAML file is located, depending on the 'root-relative'
@@ -704,7 +703,6 @@ class RedirectingFileSystemParser;
/// 'contents': [ <file or directory entries> ]
/// }
/// \endverbatim
-///
/// The default attributes for such virtual directories are:
/// \verbatim
/// MTime = now() when created
@@ -713,7 +711,6 @@ class RedirectingFileSystemParser;
/// Size = 0
/// UniqueID = unspecified unique value
/// \endverbatim
-///
/// When a path prefix matches such a directory, the next component in the path
/// is matched against the entries in the 'contents' array.
///
@@ -726,7 +723,6 @@ class RedirectingFileSystemParser;
/// 'external-contents': <path to external directory>
/// }
/// \endverbatim
-///
/// and inherit their attributes from the external directory. When a path
/// prefix matches such an entry, the unmatched components are appended to the
/// 'external-contents' path, and the resulting path is looked up in the
@@ -741,7 +737,6 @@ class RedirectingFileSystemParser;
/// 'external-contents': <path to external file>
/// }
/// \endverbatim
-///
/// Their attributes and file contents are determined by looking up the file at
/// their 'external-contents' path in the external file system.
///
|
Blank comment line afer \endverbatim malfunctions the doxygen parser. Check the "Detailed Description" section on https://llvm.org/doxygen/classllvm_1_1vfs_1_1RedirectingFileSystem.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure - happy to give this a go. Thanks!
@yelleyee Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested Please check whether problems have been caused by your change specifically, as How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
Blank comment line afer \endverbatim malfunctions the doxygen parser.
Check the "Detailed Description" section on
https://llvm.org/doxygen/classllvm_1_1vfs_1_1RedirectingFileSystem.html
Screenshot is attached below