From: Vladimír Vondruš <mosra@centrum.cz>
Date: Sun, 6 May 2018 11:16:20 +0000 (+0200)
Subject: doc: highlight the Doxygen search functionality a bit more.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=6f420f97b7daa1c0a08a698ed7d0cd681e7e2f19;p=blog.git

doc: highlight the Doxygen search functionality a bit more.
---

diff --git a/doc/doxygen.rst b/doc/doxygen.rst
index e1f786a4..8f91f2c1 100644
--- a/doc/doxygen.rst
+++ b/doc/doxygen.rst
@@ -26,7 +26,7 @@ Doxygen theme
 #############
 
 :summary: A modern, mobile-friendly drop-in replacement for the stock Doxygen
-    HTML output, generated from Doxygen-produced XML files
+    HTML output with a first-class search functionality
 
 .. role:: cpp(code)
     :language: cpp
@@ -46,9 +46,10 @@ Doxygen theme
     :language: sh
 
 A modern, mobile-friendly drop-in replacement for the stock
-`Doxygen <http://www.doxygen.org>`_ HTML output, generated from
-Doxygen-produced XML files. Generated filenames and URLs are fully compatible
-with the stock output to avoid broken links once you switch.
+`Doxygen <http://www.doxygen.org>`_ HTML output, with a first-class search
+functionality. Generated from Doxygen-produced XML files, filenames and URLs
+are fully compatible with the stock output to avoid broken links once you
+switch.
 
 .. button-success:: http://doc.magnum.graphics
 
@@ -144,6 +145,22 @@ If you see something unexpected or not see something expected, check the
     instead of raster images / MathJax
 -   Uses Pygments for better code highlighting
 
+`Search`_
+---------
+
+-   Search anywhere from a page by opening a popup using a hotkey
+-   Lookahead with instant feedback without requiring any server-side backend
+-   Search for symbols using any prefix
+-   Fully controllable by keyboard
+
+.. image:: {filename}/static/opengl-search.png
+
+.. note-success::
+
+    If you want to know more, the search functionality implementation and
+    features are detailed
+    `in this blog post <http://blog.magnum.graphics/meta/implementing-a-fast-doxygen-search/>`_.
+
 `Important differences to stock HTML output`_
 ---------------------------------------------
 
@@ -412,8 +429,8 @@ This will put links to namespaces Foo, Bar and Utils as a sub-items of a
 top-level *Namespaces* item and links to two subdirectories as sub-items of the
 *Files* item.
 
-`Search`_
----------
+`Search options`_
+-----------------
 
 Symbol search is implemented using JavaScript Typed Arrays and does not need
 any server-side functionality to perform well --- the client automatically
diff --git a/doc/static/opengl-search.png b/doc/static/opengl-search.png
new file mode 100644
index 00000000..c607d4bf
Binary files /dev/null and b/doc/static/opengl-search.png differ