From da227a49ebf02c9ceee8117d5e8e44496a86bc50 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Tue, 1 Jan 2019 20:50:48 +0100 Subject: [PATCH] Fix Doxygen documentation generation. Back-ported from 1.4.x and verified. --- FL/Fl_Input.H | 7 +- FL/Fl_Tree.H | 2 +- documentation/src/fltk-book.tex.in | 162 +++++++++++++++++++++++------ 3 files changed, 134 insertions(+), 37 deletions(-) diff --git a/FL/Fl_Input.H b/FL/Fl_Input.H index d8fabb561..4967935e1 100644 --- a/FL/Fl_Input.H +++ b/FL/Fl_Input.H @@ -36,8 +36,9 @@ Character composition is done using dead keys and/or a compose key as defined by the operating system.

- - + +
Fl_Input keyboard and mouse bindings.
+
Keyboard and mouse bindings.
Mouse button 1 @@ -75,7 +76,7 @@

- + diff --git a/FL/Fl_Tree.H b/FL/Fl_Tree.H index d35762c5f..9f4c685cd 100644 --- a/FL/Fl_Tree.H +++ b/FL/Fl_Tree.H @@ -235,7 +235,7 @@ /// The following table lists keyboard bindings for navigating the tree: /// ///
Fl_Input platform specific keyboard bindings.Platform specific keyboard bindings.
Windows/Linux Mac
-/// +/// /// /// /// diff --git a/documentation/src/fltk-book.tex.in b/documentation/src/fltk-book.tex.in index 13361ba24..7164687b6 100644 --- a/documentation/src/fltk-book.tex.in +++ b/documentation/src/fltk-book.tex.in @@ -1,44 +1,137 @@ -\documentclass[a4paper]{book} -\usepackage{a4wide} -\usepackage{makeidx} -\usepackage{fancyhdr} +% Latex header for FLTK generated by doxygen 1.8.13 +\batchmode +\documentclass[twoside]{book} + +% Packages required by doxygen +\usepackage{fixltx2e} +\usepackage{calc} +\usepackage{doxygen} +\usepackage[export]{adjustbox} % also loads graphicx \usepackage{graphicx} +\usepackage[utf8]{inputenc} +\usepackage{makeidx} \usepackage{multicol} -\usepackage{float} +\usepackage{multirow} +\PassOptionsToPackage{warn}{textcomp} \usepackage{textcomp} -\usepackage{alltt} -\usepackage{times} +\usepackage[nointegrals]{wasysym} +\usepackage[table]{xcolor} + +% Font selection +\usepackage[T1]{fontenc} +\usepackage[scaled=.90]{helvet} +\usepackage{courier} +\usepackage{amssymb} +\usepackage{sectsty} +\renewcommand{\familydefault}{\sfdefault} +\allsectionsfont{% + \fontseries{bc}\selectfont% + \color{darkgray}% +} +\renewcommand{\DoxyLabelFont}{% + \fontseries{bc}\selectfont% + \color{darkgray}% +} +\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} + +% Page & text layout +\usepackage{geometry} +\geometry{% + a4paper,% + top=2.5cm,% + bottom=2.5cm,% + left=2.5cm,% + right=2.5cm% +} +\tolerance=750 +\hfuzz=15pt +\hbadness=750 +\setlength{\emergencystretch}{15pt} +\setlength{\parindent}{0cm} +\setlength{\parskip}{3ex plus 2ex minus 2ex} +\makeatletter +\renewcommand{\paragraph}{% + \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{% + \normalfont\normalsize\bfseries\SS@parafont% + }% +} +\renewcommand{\subparagraph}{% + \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{% + \normalfont\normalsize\bfseries\SS@subparafont% + }% +} +\makeatother + +% Headers & footers +\usepackage{fancyhdr} +\pagestyle{fancyplain} +\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}} +\fancyhead[CE]{\fancyplain{}{}} +\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}} +\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}} +\fancyhead[CO]{\fancyplain{}{}} +\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} +\fancyfoot[LE]{\fancyplain{}{}} +\fancyfoot[CE]{\fancyplain{}{}} +\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} +\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }} +\fancyfoot[CO]{\fancyplain{}{}} +\fancyfoot[RO]{\fancyplain{}{}} +\renewcommand{\footrulewidth}{0.4pt} +\renewcommand{\chaptermark}[1]{% + \markboth{#1}{}% +} +\renewcommand{\sectionmark}[1]{% + \markright{\thesection\ #1}% +} + +% Indices & bibliography +\usepackage{natbib} +\usepackage[titles]{tocloft} +\setcounter{tocdepth}{3} +\setcounter{secnumdepth}{5} +\makeindex + +% Hyperlinks (required, but should be loaded last) \usepackage{ifpdf} \ifpdf -\usepackage[pdftex, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} + \usepackage[pdftex,pagebackref=true]{hyperref} \else -\usepackage[ps2pdf, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} -\usepackage{pspicture} + \usepackage[ps2pdf,pagebackref=true]{hyperref} \fi -\usepackage[utf8]{inputenc} -\usepackage{doxygen} -\makeindex -\setcounter{tocdepth}{1} -\renewcommand{\footrulewidth}{0.4pt} +\hypersetup{% + colorlinks=true,% + linkcolor=blue,% + citecolor=blue,% + unicode% +} + +% Custom commands +\newcommand{\clearemptydoublepage}{% + \newpage{\pagestyle{empty}\cleardoublepage}% +} + +\usepackage{caption} +\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top} + +%===== C O N T E N T S ===== + \begin{document} + +% Titlepage & ToC +\hypersetup{pageanchor=false, + bookmarksnumbered=true, + pdfencoding=unicode + } +\pagenumbering{alph} \begin{titlepage} -\vspace*{4.5cm} -\begin{center} +\vspace*{5cm} +\begin{center}% {\Huge FLTK @FL_VERSION@ Programming Manual}\\ \vspace*{2cm} -\begin{ImageNoCaption} - \mbox{\includegraphics[width=6cm]{FL200}} -\end{ImageNoCaption}\\ +\begin{DoxyImageNoCaption} + \mbox{\includegraphics[width=6cm]{FL200.png}} +\end{DoxyImageNoCaption}\\ \vspace*{2cm} {\Large Revision 9 by F. Costantini, D. Gibson, M. Melcher, \\ @@ -46,11 +139,11 @@ A. Schlosser, B. Spitzak, and M. Sweet.}\\ \vspace*{1.5cm} {\large Copyright 1998-@YEAR@ by Bill Spitzak and others.}\\ \vspace*{0.75cm} -{\Small +{\small This software and manual are provided under the terms of the GNU Library General Public License.}\\ -{\Small +{\small Permission is granted to reproduce this manual or any portion for any purpose,}\\ -{\Small +{\small provided this copyright and permission notice are preserved.}\\ \vspace*{2.5cm} {\large Generated by Doxygen @DOXY_VERSION@}\\ @@ -63,3 +156,6 @@ provided this copyright and permission notice are preserved.}\\ \tableofcontents \clearemptydoublepage \pagenumbering{arabic} +\hypersetup{pageanchor=true} + +%--- Begin generated contents ---
Fl_Tree keyboard bindings.Keyboard bindings.
KeyboardFL_TREE_SELECT_MULTI