Кто-либо использовал Сфинкса для документирования проекта C++? [закрытый]
Async void не позволит вам перехватить какие-либо исключения и прекратит работу вашего приложения, когда его выбросят. Исключения наблюдаются и обрабатываются как обычные исключения при использовании задачи вместо void.
Вы можете прочитать все об этом здесь ссылка
Я не могу ответить на ваш первый вопрос о том, почему он работает без потока без дополнительной информации. Я могу гарантировать, что вы подумали, что это не имеет ничего общего с многопоточностью, насколько я знаю, поскольку основной поток также является просто потоком, как и любой другой.
2 ответа
Во-первых, сохраните два дерева каталогов, исходный код и сборку . Поместите исходный код под контроль версий. Не передавайте сборку под контроль версий, перестройте ее как часть установки.
Во-вторых, прочтите http://sphinx.pocoo.org/intro.html#setting-up-the -documentation-sources .
Используйте sphinx-quickstart , чтобы построить дерево практической документации. Поиграйте с этим несколько дней, чтобы узнать, как это работает. Затем используйте его снова, чтобы создать настоящую вещь в каталогах SVN.
Организуйте свою документацию в виде хорошо спланированного дерева. Некоторым разделам нужен "index.rst" для этого раздела, некоторым нет. Это зависит от того, насколько «автономным» является раздел.
Наш верхний уровень index.rst выглядит так.
.. XXX documentation master file, created by sphinx-quickstart on Wed Dec 31 07:27:45 2008.
.. include:: overview.inc
.. _`requirements`:
Requirements
============
.. toctree::
:maxdepth: 1
requirements/requirements
requirements/admin
requirements/forward
requirements/volume
.. _`architecture`:
Architecture
============
.. toctree::
:maxdepth: 1
architecture/architecture
architecture/techstack
architecture/webservice_tech
architecture/webservice_arch
architecture/common_features
architecture/linux_host_architecture
Detailed Designs
================
.. toctree::
:maxdepth: 3
design/index
Installation and Operations
===========================
.. toctree::
:maxdepth: 1
deployment/installation
deployment/operations
deployment/support
deployment/load_test_results
deployment/reference
deployment/licensing
Programming and API's
=====================
.. toctree::
:maxdepth: 2
programming/index
**API Reference**. The `API Reference`_ is generated from the source.
.. _`API Reference`: ../../../apidoc/xxx/index.html
.. note::
The API reference must be built with `Epydoc`_.
.. _`Epydoc`: http://epydoc.sourceforge.net/
Management
==========
.. toctree::
:maxdepth: 2
:glob:
management/*
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
SVN Revision
============
::
$Revision: 319 $
Обратите внимание, мы не «включаем» API, мы просто ссылаемся на него с помощью обычной HTML-ссылки.
Sphinx имеет очень интересную надстройку под названием automdule, которая выбирает строки документации из модулей Python.
Обновление Начиная с Sphinx 1.0, поддерживаются C и C ++. http://sphinx.pocoo.org/
Взгляните на http://www.nabble.com /Using-doxygen-and-sphinx-to General-td20989904.html для подхода XML.