thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-26 09:32:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a comment

Browse Source
This commit is contained in:
Alexey Milovidov 2022-08-26 04:01:34 +02:00
parent 8afbfebd25
commit a029116fe3
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/Common/Documentation.h
View File

@ -25,7 +25,8 @@ namespace DB
* - no cross-team communication impedance; * - no cross-team communication impedance;
* *
* The disadvantages of embedded documentation are: * The disadvantages of embedded documentation are:
* - it is only suitable for uniform components of the system and not suitable for tutorials and overviews. * - it is only suitable for uniform components of the system and not suitable for tutorials and overviews;
* - it is more difficult to edit by random readers;
* *
* The documentation can contain: * The documentation can contain:
* - description (the main text); * - description (the main text);
@ -37,6 +38,9 @@ namespace DB
* The description should be represented in Markdown (or just plaintext). * The description should be represented in Markdown (or just plaintext).
* Some extensions for Markdown are added: * Some extensions for Markdown are added:
* - [example:name] will reference to an example with the corresponding name. * - [example:name] will reference to an example with the corresponding name.
*
* Documentation does not support multiple languages.
* The only available language is English.
*/ */
struct Doc struct Doc
{ {