fixes some docs compiler complaints default tip

Sun, 06 Apr 2025 13:21:17 +0200

author
Mike Becker <universe@uap-core.de>
date
Sun, 06 Apr 2025 13:21:17 +0200
changeset 1277
637d4775e79e
parent 1276
91a64ba395f7

fixes some docs compiler complaints

docs/Writerside/topics/install.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/properties.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/test.h.md file | annotate | diff | comparison | revisions
--- a/docs/Writerside/topics/install.md	Sun Apr 06 13:13:52 2025 +0200
+++ b/docs/Writerside/topics/install.md	Sun Apr 06 13:21:17 2025 +0200
@@ -1,6 +1,4 @@
----
-title: Build Instructions
----
+# Build Instructions
 
 The build processes uses configure and make.
 Make sure that you have `make` and a
@@ -14,7 +12,7 @@
 Download the latest source archive from
 <a href="https://sourceforge.net/projects/ucx/files/">Source Forge</a> and extract it somewhere on your machine.
 You can also use the command line to do this. 
-<code-block lang="sh">
+<code-block lang="shell">
 wget -O libucx.tgz https://sourceforge.net/projects/ucx/files/latest
 tar -xzf libucx.tgz
 cd libucx
@@ -24,7 +22,7 @@
 Configure the build according to your preferences. You can get a list of
 all available options with <code>./configure --help</code>.
 The recommended configuration for production builds is <code>./configure --release</code>.
-<code-block lang="sh">
+<code-block lang="shell">
     ./configure --release
     make
     make check 
--- a/docs/Writerside/topics/properties.h.md	Sun Apr 06 13:13:52 2025 +0200
+++ b/docs/Writerside/topics/properties.h.md	Sun Apr 06 13:21:17 2025 +0200
@@ -11,7 +11,7 @@
 
 An example properties file looks like this:
 
-```properties
+```Ini
 # Comment line at start of file
 key1 = value1
 key2 = value2
--- a/docs/Writerside/topics/test.h.md	Sun Apr 06 13:13:52 2025 +0200
+++ b/docs/Writerside/topics/test.h.md	Sun Apr 06 13:21:17 2025 +0200
@@ -22,7 +22,7 @@
 
 <tabs>
 <tab title="Test">
-<code-block lang="C">
+<code-block lang="C"><![CDATA[
 CX_TEST(test_foo) {
     struct mystruct *x = malloc(sizeof(*x));
     x->d = 42;
@@ -38,10 +38,10 @@
     }
     free(x);
 }
-</code-block>
+]]></code-block>
 </tab>
 <tab title="Implementation">
-<code-block lang="C">
+<code-block lang="C"><![CDATA[
 struct mystruct {
     int d;
 };
@@ -49,7 +49,7 @@
 int foo(struct mystruct *s) {
     return s->d;
 }
-</code-block>
+]]></code-block>
 </tab>
 </tabs>
 
@@ -93,7 +93,7 @@
 Instead, you define a callable test subroutine with `CX_TEST_SUBROUTINE` and call it with `CX_TEST_CALL_SUBROUTINE`.
 The following example illustrates this with an adaption of the above test case.
 
-<code-block lang="C">
+<code-block lang="C"><![CDATA[
 CX_TEST_SUBROUTINE(test_foo_params, struct mystruct *x, int d) {
     x->d = d;
     CX_TEST_ASSERT(foo(x) == d);
@@ -108,7 +108,7 @@
     }
     free(x);
 }
-</code-block>
+]]></code-block>
 
 > Any test function, test case or test subroutine, is a normal C function.
 > As such you can decide to make them `static` when you do not want external linkage.

mercurial