[globalopt] Clean up doxygen comments in GlobalOpt.cpp. #15480
Conversation
I need to fix a few things in GlobalOpt to deal with +0 changes I believe. So while I am here, I am just cleaning up the file a little bit.
|
@swift-ci smoke test and merge |
| @@ -300,7 +331,7 @@ static SILFunction *genGetterFromInit(StoreInst *Store, | |||
| return GetterF; | |||
| } | |||
|
|
|||
| /// If this is a read from a global let variable, map it. | |||
| // If this is a write to a global let variable, map it. | |||
There was a problem hiding this comment.
Is there some guiding principle for when you're using doc-comments vs. normal comments?
(I personally find the whole thing silly since no one would ever be reading a doc page to understand the internal implementation of a SIL pass, but if I know the rule I'll try to follow it)
There was a problem hiding this comment.
Yes there is a principle. In the body of a method/function always '//'. On a method declaration, '///' this is a doxygen comment that should show up. On a method impl, you should add file level comments as '//'. These are intended to not be in the public interface, but are more implementation details. Functions that are static and are not declared anywhere separately, I will use three slashes since that is the interface to the function.
I need to fix a few things in GlobalOpt to deal with +0 changes I believe. So
while I am here, I am just cleaning up the file a little bit.