Fix markup in generated gtk-doc (#4149)

kleisauke · web-flow · commit c8e151db698d · 2024-09-21T00:41:58.000+01:00
* Fix markup in generated gtk-doc Resolves: #3336. * Cleanup a bit * Convert ASCII-art tables back to HTML This reverts commit 5984718 and 870f9e5.
diff --git a/doc/meson.build b/doc/meson.build
@@ -51,7 +51,7 @@ private_libvips_headers = [
 
 private_headers = []
 foreach private_libvips_header : private_libvips_headers
-    private_headers += [join_paths(project_source_root, 'libvips', private_libvips_header)]
+    private_headers += [project_source_root / 'libvips' / private_libvips_header]
 endforeach
 
 markdown_content_files = files(
@@ -73,7 +73,7 @@ if pandoc.found()
         output: '@BASENAME@.xml',
         arguments: [
             '@INPUT@',
-            '--template=@0@'.format(join_paths(meson.current_source_dir(), 'pandoc-docbook-template.docbook')),
+            '--template=@0@'.format(meson.current_source_dir() / 'pandoc-docbook-template.docbook'),
             '--wrap=none',
             '-V', 'title=@BASENAME@',
             '-f', 'markdown+smart',
@@ -134,25 +134,21 @@ version_xml = configure_file(
 )
 
 glib_prefix = glib_dep.get_variable(pkgconfig: 'prefix')
-glib_docpath = glib_prefix / 'share' / 'gtk-doc' / 'html'
 docpath = get_option('prefix') / get_option('datadir') / 'gtk-doc' / 'html'
 
 gnome.gtkdoc('libvips',
-    mode: 'none',
     main_xml: 'libvips-docs.xml',
-    src_dir: [
-        join_paths(project_source_root, 'libvips'),
-        join_paths(project_build_root, 'libvips'),
-    ],
+    namespace: 'vips',
+    src_dir: 'libvips',
     dependencies: libvips_dep,
     ignore_headers: private_headers,
-    scan_args: '--rebuild-types',
+    scan_args: [ '--rebuild-types' ],
     mkdb_args: [ '--default-includes=vips/vips.h' ],
     fixxref_args: [
         '--html-dir=@0@'.format(docpath),
-        '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
-        '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
-        '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gio')),
+        '--extra-dir=@0@'.format(glib_prefix / gnome.gtkdoc_html_dir('glib')),
+        '--extra-dir=@0@'.format(glib_prefix / gnome.gtkdoc_html_dir('gobject')),
+        '--extra-dir=@0@'.format(glib_prefix / gnome.gtkdoc_html_dir('gio')),
     ],
     content_files: [ content_files, markdown_content_files_docbook, version_xml ],
     expand_content_files: [ content_files ],
diff --git a/libvips/create/buildlut.c b/libvips/create/buildlut.c
@@ -284,29 +284,47 @@ vips_buildlut_init(VipsBuildlut *lut)
  *
  * For example, consider this 2 x 2 matrix of (x, y) coordinates:
  *
- * |[
- *     |-------|-------|
- *     | 0     | 0     |
- *     |-------|-------|
- *     | 255   | 100   |
- *     |-------|-------|
- * ]|
+ *   <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ *     <tbody>
+ *       <row>
+ *         <entry>0</entry>
+ *         <entry>0</entry>
+ *       </row>
+ *       <row>
+ *         <entry>255</entry>
+ *         <entry>100</entry>
+ *       </row>
+ *     </tbody>
+ *   </tgroup>
  *
  * We then generate a 1 x 256 element LUT like this:
  *
- * |[
- *     |-------|-------|
- *     | Index | Value |
- *     |-------|-------|
- *     | 0     | 0     |
- *     |-------|-------|
- *     | 1     | 0.4   |
- *     |-------|-------|
- *     | etc.  | 0.4   |
- *     |-------|-------|
- *     | 255   | 100   |
- *     |-------|-------|
- * ]|
+ *   <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ *     <thead>
+ *       <row>
+ *         <entry>Index</entry>
+ *         <entry>Value</entry>
+ *       </row>
+ *     </thead>
+ *     <tbody>
+ *       <row>
+ *         <entry>0</entry>
+ *         <entry>0</entry>
+ *       </row>
+ *       <row>
+ *         <entry>1</entry>
+ *         <entry>0.4</entry>
+ *       </row>
+ *       <row>
+ *         <entry>etc.</entry>
+ *         <entry>0.4</entry>
+ *       </row>
+ *       <row>
+ *         <entry>255</entry>
+ *         <entry>100</entry>
+ *       </row>
+ *     </tbody>
+ *   </tgroup>
  *
  * This is then written as the output image, with the left column giving the
  * index in the image to place the value.
diff --git a/libvips/create/invertlut.c b/libvips/create/invertlut.c
@@ -321,15 +321,32 @@ vips_invertlut_init(VipsInvertlut *lut)
  *
  * Eg. input like this:
  *
- * |[
- *     |-------|-------|-------|-------|
- *     | 0.1   | 0.2   | 0.3   | 0.1   |
- *     |-------|-------|-------|-------|
- *     | 0.2   | 0.4   | 0.4   | 0.2   |
- *     |-------|-------|-------|-------|
- *     | 0.7   | 0.5   | 0.6   | 0.3   |
- *     |-------|-------|-------|-------|
- * ]|
+ *   <tgroup cols='4' align='left' colsep='1' rowsep='1'>
+ *     <tbody>
+ *       <row>
+ *         <entry>4</entry>
+ *         <entry>3</entry>
+ *       </row>
+ *       <row>
+ *         <entry>0.1</entry>
+ *         <entry>0.2</entry>
+ *         <entry>0.3</entry>
+ *         <entry>0.1</entry>
+ *       </row>
+ *       <row>
+ *         <entry>0.2</entry>
+ *         <entry>0.4</entry>
+ *         <entry>0.4</entry>
+ *         <entry>0.2</entry>
+ *       </row>
+ *       <row>
+ *         <entry>0.7</entry>
+ *         <entry>0.5</entry>
+ *         <entry>0.6</entry>
+ *         <entry>0.3</entry>
+ *       </row>
+ *     </tbody>
+ *   </tgroup>
  *
  * Means a patch with 10% reflectance produces an image with 20% in
  * channel 1, 30% in channel 2, and 10% in channel 3, and so on.
