From 18376d3f7b3309c0212b436602c4d83e72449ab5 Mon Sep 17 00:00:00 2001
From: Louis Chauvet <louis.chauvet@bootlin.com>
Date: Fri, 11 Oct 2024 10:07:55 +0200
Subject: [PATCH] web: Display documentation before other things

The current order for displaying references is:

- [definitions] prototype, label, typedef, variable, struct, member,
  function
- documentation
- references

This order is not very practical when you are searching for information
about a symbol, as you often want to know if the symbol is documented.

By inverting the order and displaying the documentation first, the user
experience may be improved for finding the documentation. This should not
significantly change the UX for definitions, as there are already many
definitions, and you already have to search for what you want.
---
 elixir/web.py                | 12 ++++++------
 static/dynamic-references.js |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/elixir/web.py b/elixir/web.py
index 0822858..d7f3000 100755
--- a/elixir/web.py
+++ b/elixir/web.py
@@ -659,6 +659,12 @@ def generate_ident_page(ctx, q, project, version, family, ident):
     symbol_sections = []
 
     if len(symbol_definitions) or len(symbol_references):
+        if len(symbol_doccomments):
+            symbol_sections.append({
+                'title': 'Documented',
+                'symbols': {'_unknown': [symbol_instance_to_entry(source_base_url, sym) for sym in symbol_doccomments]},
+            })
+
         if len(symbol_definitions):
             defs_by_type = OrderedDict({})
 
@@ -678,12 +684,6 @@ def generate_ident_page(ctx, q, project, version, family, ident):
                 'message': 'No definitions found in the database',
             })
 
-        if len(symbol_doccomments):
-            symbol_sections.append({
-                'title': 'Documented',
-                'symbols': {'_unknown': [symbol_instance_to_entry(source_base_url, sym) for sym in symbol_doccomments]},
-            })
-
         if len(symbol_references):
             symbol_sections.append({
                 'title': 'Referenced',
diff --git a/static/dynamic-references.js b/static/dynamic-references.js
index f8f4ff6..c2816ba 100644
--- a/static/dynamic-references.js
+++ b/static/dynamic-references.js
@@ -144,8 +144,8 @@ function generateReferencesHTML(data, project, version) {
   let symbolReferences = data["references"];
   let symbolDocumentations = data["documentations"];
   return '<div class="lxrident">' +
-    generateSymbolDefinitionsHTML(symbolDefinitions, project, version) +
     generateDocCommentsHTML(symbolDocumentations, project, version) +
+    generateSymbolDefinitionsHTML(symbolDefinitions, project, version) +
     generateSymbolReferencesHTML(symbolReferences, project, version) +
     '</div>';
 }