diff --git a/plans/doxygen_example.md b/plans/doxygen_example.md new file mode 100644 index 00000000..52581c92 --- /dev/null +++ b/plans/doxygen_example.md @@ -0,0 +1,13 @@ +Ключевые элементы документации + +| Элемент | Описание | +|---------|----------| +| //! \~english | Описание на английском языке | +| //! \~russian | Описание на русском языке | +| //! \details | | +| //! \~english | Детальное объяснение на английском языке | +| //! \~russian | Детальное объяснение на русском языке | +| //! \note | | +| //! \~english | Важное примечание о сложности/поведении на английском языке | +| //! \~russian | Важное примечание о сложности/поведении на русском языке | +| //! \~\sa | Ссылки на связанные функции |