Change many figures to tables, lots of other fixes
[dwarf-doc.git] / dwarf5 / latexdoc / generaldescription.tex
index 8f53b1e..63ec15f 100644 (file)
@@ -20,12 +20,20 @@ and the attributes define the specific characteristics of the entry.
 
 The set of tag names 
 \addtoindexx{tag names|see{debugging information entry}}
-is listed in Figure \refersec{fig:tagnames}. 
+is listed in Figure \refersec{tab:tagnames}. 
 The debugging information entries they identify are
 described in Sections 3, 4 and 5.
 
 % These each need to link to definition page: FIXME
-\begin{figure}[here]
+
+\begin{figure}
+%\begin{table}
+%\begin{tabular}{|}
+%\caption{Tag names}
+%\label{tab:tagnames}
+%\hline
+%\end{tabular)
+%\end{table}
 \autorows[0pt]{c}{2}{l}{
 \livelink{chap:DWTAGaccessdeclaration}{DW\-\_TAG\-\_access\-\_declaration},
 \livelink{chap:DWTAGarraytype}{DW\-\_TAG\-\_array\-\_type},
@@ -88,11 +96,12 @@ described in Sections 3, 4 and 5.
 \livelink{chap:DWTAGvolatiletype}{DW\-\_TAG\-\_volatile\-\_type},
 \livelink{chap:DWTAGwithstmt}{DW\-\_TAG\-\_with\-\_stmt},
 }
-\caption{Tag names}\label{fig:tagnames}
+\caption{Tag names}
+\label{tab:tagnames}
 \end{figure}
 
 
-The debugging information entry descriptions 
+\textit{The debugging information entry descriptions 
 in Sections 3, 4 and 5 generally include mention of
 most, but not necessarily all, of the attributes 
 that are normally or possibly used with the entry.
@@ -101,9 +110,11 @@ pervasive and invariant across many kinds of
 debugging information entries, are described in 
 this section and not necessarily mentioned in all
 contexts where they may be appropriate. 
-Examples include \livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial}, the declaration
-coordinates, and 
-\livelink{chap:DWATdescription}{DW\-\_AT\-\_description}, among others.
+Examples include 
+\livelink{chap:DWATartificial}{DW\-\_AT\-\_artificial}, 
+the declaration coordinates, and 
+\livelink{chap:DWATdescription}{DW\-\_AT\-\_description}, 
+among others.}
 
 The debugging information entries are contained 
 in the \addtoindex{.debug\_info} and 
@@ -142,7 +153,7 @@ debugging information entry.
 
 Attribute value forms belong
 \addtoindexx{tag names!list of}
-to one of the classes shown in Figure \refersec{tab:classesofattributevalue}.
+to one of the classes shown in Table \refersec{tab:classesofattributevalue}.
 
 \setlength{\extrarowheight}{0.1cm}
 \addtoindexx{attributes!list of}
@@ -374,11 +385,13 @@ actually declared in the source}{objects or types that are not actually declared
 &\livelinki{chap:DWATvtableelemlocationvirtualfunctiontablevtableslot}{Virtual function vtable slot}{virtual function vtable slot}\\
 \end{longtable}
 
-\begin{figure}[here]
+\begin{table}[here]
+\caption{Classes of Attribute value}
+\label{tab:classesofattributevalue}
 \centering
 % Attribute Class entries need a ref to definition point.
 \setlength{\extrarowheight}{0.1cm}
-\label{tab:classesofattributevalue}
+
 \begin{tabular}{l|p{10cm}} \hline
 Attribute Class & General Use and Encoding \\ \hline
 \livetargi{chap:address}{address}{address class}
@@ -437,8 +450,7 @@ the debugging information entry or as an offset in a separate
 string table.
  
 \end{tabular}
-\caption{Classes of Attribute value}
-\end{figure}
+\end{table}
 
 % It is difficult to get the above table to appear before
 % the end of the chapter without a clearpage here.
@@ -1543,19 +1555,14 @@ represented by a
 \livelink{chap:DWATaccessibility}{DW\-\_AT\-\_accessibility} 
 attribute, whose
 \addtoindexx{accessibility attribute}
-value is a constant drawn from the set of codes listed in Figur
-\ref{fig:accessibilitycodes}.
+value is a constant drawn from the set of codes listed in Tabl
+\refersec{tab:accessibilitycodes}.
 
-\begin{figure}[here]
-\begin{description}
-\centering
-\item [\livetarg{chap:DWACCESSpublic}{DW\-\_ACCESS\-\_public}]
-\item [\livetarg{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}]
-\item [\livetarg{chap:DWACCESSprotected}{DW\-\_ACCESS\-\_protected}]
-\end{description}
-\caption{Accessibility codes}
-\label{fig:accessibilitycodes}
-\end{figure}
+\begin{simplenametable}{Accessibility codes}{tab:accessibilitycodes}
+\livetarg{chap:DWACCESSpublic}{DW\-\_ACCESS\-\_public}          \\
+\livetarg{chap:DWACCESSprivate}{DW\-\_ACCESS\-\_private}        \\
+\livetarg{chap:DWACCESSprotected}{DW\-\_ACCESS\-\_protected}    \\
+\end{simplenametable}
 
 \section{Visibility of Declarations}
 \label{chap:visibilityofdeclarations}
@@ -1572,18 +1579,13 @@ visibility of a declaration is represented
 by a \livelink{chap:DWATvisibility}{DW\-\_AT\-\_visibility}
 attribute\addtoindexx{visibility attribute}, whose value is a
 constant drawn from the set of codes listed in 
-Figure \ref{fig:visibilitycodes}.
+Table \refersec{tab:visibilitycodes}.
 
-\begin{figure}[here]
-\begin{description}
-\centering
-\item [\livetarg{chap:DWVISlocal}{DW\-\_VIS\-\_local}]
-\item [\livetarg{chap:DWVISexported}{DW\-\_VIS\-\_exported}]
-\item [\livetarg{chap:DWVISqualified}{DW\-\_VIS\-\_qualified}]
-\end{description}
-\caption{Visibility codes}
-\label{fig:visibilitycodes}
-\end{figure}
+\begin{simplenametable}{Visibility Codes}{tab:visibilitycodes}
+\livetarg{chap:DWVISlocal}{DW\-\_VIS\-\_local}          \\
+\livetarg{chap:DWVISexported}{DW\-\_VIS\-\_exported}    \\
+\livetarg{chap:DWVISqualified}{DW\-\_VIS\-\_qualified}  \\
+\end{simplenametable}
 
 \section{Virtuality of Declarations}
 \label{chap:virtualityofdeclarations}
@@ -1596,18 +1598,13 @@ virtuality of a declaration is represented by a
 \livelink{chap:DWATvirtuality}{DW\-\_AT\-\_virtuality}
 attribute\addtoindexx{virtuality attribute}, whose value is a constant drawn
 from the set of codes listed in 
-Figure \ref{fig:virtualitycodes}.
+Table \refersec{tab:virtualitycodes}.
 
-\begin{figure}[here]
-\begin{description}
-\centering
-\item [\livetarg{chap:DWVIRTUALITYnone}{DW\-\_VIRTUALITY\-\_none}]
-\item [\livetarg{chap:DWVIRTUALITYvirtual}{DW\-\_VIRTUALITY\-\_virtual}]
-\item [\livetarg{chap:DWVIRTUALITYpurevirtual}{DW\-\_VIRTUALITY\-\_pure\-\_virtual}]
-\end{description}
-\caption{Virtuality codes}
-\label{fig:virtualitycodes}
-\end{figure}
+\begin{simplenametable}[2.5in]{Virtuality codes}{tab:virtualitycodes}
+\livetarg{chap:DWVIRTUALITYnone}{DW\-\_VIRTUALITY\-\_none}                      \\
+\livetarg{chap:DWVIRTUALITYvirtual}{DW\-\_VIRTUALITY\-\_virtual}                \\
+\livetarg{chap:DWVIRTUALITYpurevirtual}{DW\-\_VIRTUALITY\-\_pure\-\_virtual}    \\
+\end{simplenametable}
 
 \section{Artificial Entries}
 \label{chap:artificialentries}
@@ -1875,8 +1872,8 @@ of language translators that use some form of mangled name
 form of the name in the 
 DWARF \livelink{chap:DWATname}{DW\-\_AT\-\_name} attribute,
 \addtoindexx{name attribute}
-including the keyword operator (in names such as “operator
-+”), if present. See also 
+including the keyword operator (in names such as \doublequote{operator +}),
+if present. See also 
 Section \refersec{chap:linkagenames} regarding the use
 of \livelink{chap:DWATlinkagename}{DW\-\_AT\-\_linkage\-\_name} for 
 \addtoindex{mangled names}
@@ -1958,6 +1955,7 @@ In addition, a non-contiguous range of
 addresses may also be specified for the
 \livelink{chap:DWATstartscope}{DW\-\_AT\-\_start\-\_scope} attribute.
 \addtoindexx{start scope attribute}
+
 If an entity has no associated machine code, 
 none of these attributes are specified.