Badlop
7cd5808766
Mark toplevel options, commands and modules that changed in latest version
2024-04-24 13:20:37 +02:00
Badlop
cd7eedf589
Update API to mkdocs
2024-04-24 13:20:35 +02:00
Badlop
27bd8852a1
Update name of API section
2024-04-24 13:20:34 +02:00
Badlop
effcf0b7cf
Update markdown text for version notes, to work with mkdocs
2024-04-24 13:20:33 +02:00
Badlop
71b9db688a
Fix markdown indentation of JSON examples
2024-04-24 13:20:32 +02:00
Badlop
569f0b303b
Use same module shorthand in API documentation than in module docs
2024-04-24 13:20:29 +02:00
Badlop
68c0c4d94f
Update doc headers to MkDocs and mention ejabberd version used
2024-04-24 13:20:27 +02:00
Badlop
ed6762b8ee
Don't name integer and string results in API examples ( #4198 )
...
Since ejabberd 24.02, mod_http_api does not name any results,
previously integer and strings were named, but other results were not.
And ejabberdctl obviously does not name results either.
Only ejabberd_xmlrpc does.
Consequently, the documentation should not name results in the examples.
2024-04-12 12:08:03 +02:00
Badlop
589521bfd8
Update copyright year to 2024 ( #4139 )
2024-01-22 17:29:13 +01:00
Badlop
fc13fdceca
Docs: Separate tags with commas in markdown docs
2024-01-04 22:01:21 +01:00
Badlop
d585b1fcb6
Docs: When definer is unknown, don't show Module section
2024-01-04 22:01:21 +01:00
Badlop
57bd0ef4f5
Docs: Optional support to get commands from runtime instead of BEAM files, based in bdeb4a7
2024-01-04 22:01:21 +01:00
Badlop
0961fa1830
Commands: When result is rescode, result_desc is automatically added
2024-01-04 21:53:14 +01:00
Paweł Chmielowski
426fd14b11
Make sure that policy=user commands have host instead of server arg in docs
...
We renamed them in ejabberd_command, but forgot to update doc geenerator.
2023-09-20 14:06:23 +02:00
Paweł Chmielowski
758c87f564
Revert notes placement when generating markdown api commands documentation
2023-01-19 13:24:51 +01:00
Paweł Chmielowski
b6dde41000
Improve output in gen_html_doc_for_commands command
2023-01-19 11:45:33 +01:00
Badlop
243697e25a
Update copyright year to 2023 ( #3967 )
2023-01-10 13:52:04 +01:00
Badlop
b3211b1f71
Update copyright year to 2022
2022-02-11 09:39:25 +01:00
Badlop
8b6c90c2d9
Tell dialyzer that gen_tags only cares about markdown output, not html
2021-08-23 15:39:01 +02:00
Badlop
655dcbcb74
New command to produce markdown with tags and their associated commands
2021-08-23 14:04:54 +02:00
Badlop
ac4f240261
Produce module names with specific syntax, docs Makefile will convert to links
2021-08-23 14:04:52 +02:00
Badlop
8af66b0831
Update API Reference page menu name and order
2021-08-23 14:04:31 +02:00
Badlop
b22779f018
Show tags and definer module in generated API document when it's a gen_mod
2021-07-30 01:14:34 +02:00
Badlop
f61607df65
Don't add ejabberd version in API page either, following 3e4ebfae7
2021-05-11 18:36:08 +02:00
Badlop
999d0af502
New 'note' field in commands and options documentation
2021-05-05 11:57:02 +02:00
Badlop
6e0161470e
Update newest copyright year to 2021 ( #3464 )
2021-01-27 17:02:06 +01:00
Badlop
80a502782b
Use the same leading sentence than other sections
2020-07-06 16:39:15 +02:00
Badlop
da18245d9a
Indicate which ejabberd version is used to produce the page
2020-04-08 18:47:50 +02:00
Badlop
5cc9a1fe44
Don't make commands subsections, so Docs TOC plage is cleaner
2020-04-08 18:45:29 +02:00
Badlop
2d32c66fd7
Update copyright to 2020 ( #3149 )
2020-01-28 15:49:23 +01:00
Evgeny Khramtsov
5770946f03
Correctly handle unicode in log messages
2019-09-23 15:17:20 +03:00
Badlop
55417dfb37
Update copyright to 2019 ( #2756 )
2019-01-08 22:53:27 +01:00
Badlop
0146189b65
Add markdown options as specified in the docs git repo
2018-08-07 16:59:26 +02:00
Evgeniy Khramtsov
fd8e07af47
Get rid of ejabberd.hrl header
...
The header consisted of too many unrelated stuff and macros misuse.
Some stuff is moved into scram.hrl and type_compat.hrl.
All macros have been replaced with the corresponding function calls.
TODO: probably type_compat.hrl is not even needed anymore since
we support only Erlang >= OTP 17.5
2018-06-14 14:00:47 +03:00
Paweł Chmielowski
60a8623929
Change formatting of commands markdown documentation
2018-02-13 16:27:39 +01:00
Badlop
c2911222e4
Commands markdown also lack arguments when policy=user
2018-02-07 16:39:18 +01:00
Evgeniy Khramtsov
cdc7c1d1ed
Update copyright dates
2018-01-05 23:18:58 +03:00
Paweł Chmielowski
e216654c52
Don't add indentation after single item result in docs
2017-07-18 17:48:53 +02:00
Christophe Romain
cc3391cc1c
Use string:join instead of lists:join
2017-07-18 15:43:46 +02:00
Christophe Romain
b8d56a7c11
Improve formatting of documented API parameters
2017-07-18 15:01:01 +02:00
Paweł Chmielowski
2cd193f97c
Expand catch block used to report errors in doc generator
2017-07-14 17:18:07 +02:00
Christophe Romain
a7841ed486
Improve API documentation generator
2017-06-20 14:45:57 +02:00
Paweł Chmielowski
5424ead01d
Generate better errors when not being able to generate documentation
2017-06-19 16:30:45 +02:00
Paweł Chmielowski
96d385bf82
Another tweak to md generator
2017-06-19 15:10:34 +02:00
Paweł Chmielowski
8e2258b16a
Update markdown api document generator
2017-06-19 15:02:02 +02:00
Badlop
a1e8d3c3dc
Commands documentation lack arguments when policy=user ( #1514 )
2017-02-17 12:37:42 +01:00
Badlop
5fdd1c39fe
Update copyright date automatically ( #1442 )
2017-01-02 21:42:06 +01:00
Christophe Romain
12683b4aaf
Fix typo in copyright date
2016-11-23 14:36:11 +01:00
Evgeniy Khramtsov
fa31e3ef23
Deprecate jlib:integer_to_binary/1 and jlib:binary_to_integer/1
2016-09-24 23:34:28 +03:00
Paweł Chmielowski
a9de13c5d9
Don't include empty line after java example
2016-02-25 12:14:17 +01:00
