fix doxygen brief in subzero header files
There is a consistent mistake in most of the file level subzero doxygen
comments which stems from a problem with brief.
Basically, there are two types of documentation in Doxygen, inline and
structural documentation. File level documentation is always structural
because inline documentation must either come before or after the entity
and for a file that would be impossible.
When you have structure documentation, the brief and detailed is
handled differently and you have to explicity put the \brief qualifier in.
We were only doing this for a few files so when you looked the doxygen
for the source directory, the description was blank for almost all of them.
If you build docs with this patch and look at the "files" and src
directory, you will see all the brief descriptions now.
In addition I deleted the text "This file ..." from the
beginning of all the file desriptions because it's redundant when you look at the doxygen output and adds
no information but takes up space in the descripton.
BUG=
R=stichnot@chromium.org
Review URL: https://codereview.chromium.org/1488913002 .
diff --git a/src/IceLiveness.cpp b/src/IceLiveness.cpp
index 25cfd09..2bfa624 100644
--- a/src/IceLiveness.cpp
+++ b/src/IceLiveness.cpp
@@ -8,14 +8,15 @@
//===----------------------------------------------------------------------===//
///
/// \file
-/// This file provides some of the support for the Liveness class. In
-/// particular, it handles the sparsity representation of the mapping between
-/// Variables and CfgNodes. The idea is that since most variables are used only
-/// within a single basic block, we can partition the variables into "local" and
-/// "global" sets. Instead of sizing and indexing vectors according to
-/// Variable::Number, we create a mapping such that global variables are mapped
-/// to low indexes that are common across nodes, and local variables are mapped
-/// to a higher index space that is shared across nodes.
+/// \brief Provides some of the support for the Liveness class.
+
+/// In particular, it handles the sparsity representation of the mapping
+/// between Variables and CfgNodes. The idea is that since most variables are
+/// used only within a single basic block, we can partition the variables into
+/// "local" and "global" sets. Instead of sizing and indexing vectors according
+/// to Variable::Number, we create a mapping such that global variables are
+/// mapped to low indexes that are common across nodes, and local variables are
+/// mapped to a higher index space that is shared across nodes.
///
//===----------------------------------------------------------------------===//
