\select@language {english}
\contentsline {chapter}{\numberline {1}Introduction}{1}{chapter.1}
\contentsline {chapter}{\numberline {2}Sphinx Install}{3}{chapter.2}
\contentsline {section}{\numberline {2.1}Image output}{3}{section.2.1}
\contentsline {section}{\numberline {2.2}PDF and LaTeX builds}{4}{section.2.2}
\contentsline {section}{\numberline {2.3}Checking for Sphinx dependencies}{4}{section.2.3}
\contentsline {chapter}{\numberline {3}Sphinx Build}{5}{chapter.3}
\contentsline {chapter}{\numberline {4}Writing Documentation}{7}{chapter.4}
\contentsline {section}{\numberline {4.1}Specific guidelines for the kernel documentation}{7}{section.4.1}
\contentsline {section}{\numberline {4.2}the C domain}{8}{section.4.2}
\contentsline {section}{\numberline {4.3}list tables}{8}{section.4.3}
\contentsline {chapter}{\numberline {5}Figures \& Images}{11}{chapter.5}
\contentsline {chapter}{\numberline {6}Including kernel-doc comments}{13}{chapter.6}
\contentsline {chapter}{\numberline {7}Writing kernel-doc comments}{15}{chapter.7}
\contentsline {section}{\numberline {7.1}How to format kernel-doc comments}{15}{section.7.1}
\contentsline {section}{\numberline {7.2}Highlights and cross-references}{16}{section.7.2}
\contentsline {subsection}{\numberline {7.2.1}Cross-referencing from reStructuredText}{16}{subsection.7.2.1}
\contentsline {section}{\numberline {7.3}Function documentation}{17}{section.7.3}
\contentsline {section}{\numberline {7.4}Structure, union, and enumeration documentation}{17}{section.7.4}
\contentsline {subsection}{\numberline {7.4.1}In-line member documentation comments}{18}{subsection.7.4.1}
\contentsline {subsection}{\numberline {7.4.2}Private members}{18}{subsection.7.4.2}
\contentsline {section}{\numberline {7.5}Typedef documentation}{18}{section.7.5}
\contentsline {section}{\numberline {7.6}Overview documentation comments}{19}{section.7.6}
\contentsline {section}{\numberline {7.7}Recommendations}{19}{section.7.7}
\contentsline {chapter}{\numberline {8}Including uAPI header files}{21}{chapter.8}
\contentsline {section}{\numberline {8.1}parse\_headers.pl}{21}{section.8.1}
\contentsline {subsection}{\numberline {8.1.1}NAME}{21}{subsection.8.1.1}
\contentsline {subsection}{\numberline {8.1.2}SYNOPSIS}{21}{subsection.8.1.2}
\contentsline {subsection}{\numberline {8.1.3}OPTIONS}{21}{subsection.8.1.3}
\contentsline {subsection}{\numberline {8.1.4}DESCRIPTION}{21}{subsection.8.1.4}
\contentsline {subsection}{\numberline {8.1.5}EXAMPLES}{22}{subsection.8.1.5}
\contentsline {subsection}{\numberline {8.1.6}BUGS}{23}{subsection.8.1.6}
\contentsline {subsection}{\numberline {8.1.7}COPYRIGHT}{23}{subsection.8.1.7}