Files
pip/doc/pages/examples.md
2026-03-12 14:46:57 +03:00

3.5 KiB
Raw Permalink Blame History

~english \page examples Examples ~russian \page examples Примеры

~english

The \c doc/examples directory contains sample code that can be built and run. Below, each file is listed with a short description and a pointer to related documentation where applicable.

File Description See also
pibytearray.cpp \a PIByteArray and binary stream usage \ref iostream
pichunkstream.cpp \a PIChunkStream read/write \ref chunk_stream
picollection.cpp Collection helpers
picontainers.cpp Containers (\a PIVector, \a PIMap, etc.) \ref summary
piconfig.cpp \a PIConfig, \a PIConfig::Entry, dotted paths \ref config
picli.cpp \a PICLI (stub) \ref application
picout.cpp \a PICout, console output \ref using_basic
pievaluator.cpp \a PIEvaluator, expression evaluation \ref summary (Mathematics)
piincludes.cpp Include paths and module discovery
piiodevice.cpp \a PIIODevice, custom device and \a PIConfig \ref config, \ref connection
pikbdlistener.cpp \a PIKbdListener, keyboard input \ref console
pimutex.cpp \a PIMutex (minimal) \ref threading
piobject.cpp \a PIObject, events and handlers \ref PIObject_sec0
piparsehelper.cpp Parse utilities
pistatemachine.cpp \a PIStateMachine, states and transitions \ref state_machine
pitimer.cpp \a PITimer, periodic callbacks \ref threading

Examples are referenced from the main PIP build when documentation is enabled; paths and build integration may vary by project configuration.

~russian

В каталоге \c doc/examples находятся примеры кода, которые можно собирать и запускать. Ниже перечислены файлы с кратким описанием и ссылкой на связанную документацию.

Файл Описание См. также
pibytearray.cpp \a PIByteArray и бинарный поток \ref iostream
pichunkstream.cpp Чтение/запись \a PIChunkStream \ref chunk_stream
picollection.cpp Вспомогательные типы коллекций
picontainers.cpp Контейнеры (\a PIVector, \a PIMap и др.) \ref summary
piconfig.cpp \a PIConfig, \a PIConfig::Entry, точечные пути \ref config
picli.cpp \a PICLI (заглушка) \ref application
picout.cpp \a PICout, вывод в консоль \ref using_basic
pievaluator.cpp \a PIEvaluator, вычисление выражений \ref summary (Математика)
piincludes.cpp Пути включения и поиск модулей
piiodevice.cpp \a PIIODevice, своё устройство и \a PIConfig \ref config, \ref connection
pikbdlistener.cpp \a PIKbdListener, ввод с клавиатуры \ref console
pimutex.cpp \a PIMutex (минимальный пример) \ref threading
piobject.cpp \a PIObject, события и обработчики \ref PIObject_sec0
piparsehelper.cpp Утилиты разбора
pistatemachine.cpp \a PIStateMachine, состояния и переходы \ref state_machine
pitimer.cpp \a PITimer, периодические вызовы \ref threading

Примеры подключаются к сборке PIP при включённой документации; пути и способ интеграции зависят от конфигурации проекта.