Skip to content

Commit 83a706d

Browse files
author
Reid Spencer
committed
Include corrected documentation on class hierarchy of GlobalValue (derived
from constant). llvm-svn: 27702
1 parent efc0503 commit 83a706d

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

llvm/docs/ProgrammersManual.html

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1710,8 +1710,8 @@ <h3>Iteration</h3>
17101710
href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
17111711
doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
17121712
Class</a><br>
1713-
Superclasses: <a href="#User"><tt>User</tt></a>, <a
1714-
href="#Value"><tt>Value</tt></a></p>
1713+
Superclasses: <a href="#Constant"><tt>Constant</tt></a>,
1714+
<a href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
17151715

17161716
<p>Global values (<a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
17171717
href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
@@ -1778,15 +1778,17 @@ <h3>Iteration</h3>
17781778
<p><tt>#include "<a
17791779
href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
17801780
info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
1781-
Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
1782-
href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
1781+
Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
1782+
<a href="#Constant"><tt>Constant</tt></a>,
1783+
<a href="#User"><tt>User</tt></a>,
1784+
<a href="#Value"><tt>Value</tt></a></p>
17831785

17841786
<p>The <tt>Function</tt> class represents a single procedure in LLVM. It is
17851787
actually one of the more complex classes in the LLVM heirarchy because it must
17861788
keep track of a large amount of data. The <tt>Function</tt> class keeps track
1787-
of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal <a
1788-
href="#Argument"><tt>Argument</tt></a>s, and a <a
1789-
href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
1789+
of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal
1790+
<a href="#Argument"><tt>Argument</tt></a>s, and a
1791+
<a href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
17901792

17911793
<p>The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most
17921794
commonly used part of <tt>Function</tt> objects. The list imposes an implicit
@@ -1915,20 +1917,22 @@ <h3>Iteration</h3>
19151917
href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt>
19161918
<br>
19171919
doxygen info: <a href="/doxygen/classllvm_1_1GlobalVariable.html">GlobalVariable
1918-
Class</a><br> Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
1919-
href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
1920+
Class</a><br>
1921+
Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
1922+
<a href="#Constant"><tt>Constant</tt></a>,
1923+
<a href="#User"><tt>User</tt></a>,
1924+
<a href="#Value"><tt>Value</tt></a></p>
19201925

19211926
<p>Global variables are represented with the (suprise suprise)
19221927
<tt>GlobalVariable</tt> class. Like functions, <tt>GlobalVariable</tt>s are also
19231928
subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such are
19241929
always referenced by their address (global values must live in memory, so their
1925-
"name" refers to their address). See <a
1926-
href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this. Global variables
1927-
may have an initial value (which must be a <a
1928-
href="#Constant"><tt>Constant</tt></a>), and if they have an initializer, they
1929-
may be marked as "constant" themselves (indicating that their contents never
1930-
change at runtime).</p>
1931-
1930+
"name" refers to their constant address). See
1931+
<a href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this. Global
1932+
variables may have an initial value (which must be a
1933+
<a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer,
1934+
they may be marked as "constant" themselves (indicating that their contents
1935+
never change at runtime).</p>
19321936
</div>
19331937

19341938
<!-- _______________________________________________________________________ -->

0 commit comments

Comments
 (0)