Доработал модуль TIM (с точки зрения документции. Код не проверен)
Доработна документация в целом - добавелн main page - исправлены ошибки в шапках и коментах - добавлен граф инклюдов
This commit is contained in:
@@ -1,38 +1,38 @@
|
||||
\doxysection{bit\+\_\+access.\+h}
|
||||
\hypertarget{bit__access_8h_source}{}\label{bit__access_8h_source}\index{E:/.WORK/STM32/STM32\_ExtendedLibs/MyLibsGeneral/Inc/bit\_access.h@{E:/.WORK/STM32/STM32\_ExtendedLibs/MyLibsGeneral/Inc/bit\_access.h}}
|
||||
|
||||
\mbox{\hyperlink{bit__access_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00001}00001\ \textcolor{comment}{/**\ }}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00002}00002\ \textcolor{comment}{**************************************************************************}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00003}00003\ \textcolor{comment}{*\ @file\ mylibs\_defs.h}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00004}00004\ \textcolor{comment}{*\ @brief\ Заголочный\ файл\ для\ дефайнов\ библиотеки\ MyLibsGeneral.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00003}00003\ \textcolor{comment}{*\ @file\ bit\_access.h}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00004}00004\ \textcolor{comment}{*\ @brief\ Заголочный\ файл\ для\ дефайнов\ битового\ доступа.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00005}00005\ \textcolor{comment}{**************************************************************************}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00006}00006\ \textcolor{comment}{*\ @defgroup\ BIT\_ACCESS\_DEFINES\ \ \ \ Bit\ access\ defines}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00007}00007\ \textcolor{comment}{*\ @ingroup\ \ MYLIBS\_DEFINES}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00008}00008\ \textcolor{comment}{*\ @brief\ \ \ \ \ Макросы\ и\ typedef'ы\ для\ работы\ с\ битами\ в\ unsigned\ типах.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00009}00009\ \textcolor{comment}{*\ @details}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00010}00010\ \textcolor{comment}{*\ В\ этом\ файле\ определены\ макросы\ для\ получения\ значения\ конкретного\ бита\string^}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00011}00011\ \textcolor{comment}{*\ -\/\ @ref\ uint8\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00012}00012\ \textcolor{comment}{*\ -\/\ @ref\ uint16\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00013}00013\ \textcolor{comment}{*\ -\/\ @ref\ uint32\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00014}00014\ \textcolor{comment}{*\ -\/\ @ref\ uint64\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00015}00015\ \textcolor{comment}{*}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00016}00016\ \textcolor{comment}{*\ Особенности\ использования:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00017}00017\ \textcolor{comment}{*\ \ -\/\ Индекс\ бита\ должен\ быть\ **константой\ на\ этапе\ компиляции**.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00018}00018\ \textcolor{comment}{*\ \ \ \ Пример\ верного\ использования:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00019}00019\ \textcolor{comment}{*\ \ \ \ \ \ @code}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00020}00020\ \textcolor{comment}{*\ \ \ \ \ \ \ \ uint8\_t\ val\ =\ 0x05;}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00021}00021\ \textcolor{comment}{*\ \ \ \ \ \ \ \ uint8\_t\ b2\ =\ uint8\_bit(val,\ 2);\ //\ Получить\ бит\ 2}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00022}00022\ \textcolor{comment}{*\ \ \ \ \ \ \ \ uint8\_bit(val,\ 6)\ =\ 1;\ //\ Записать\ бит\ 6}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00023}00023\ \textcolor{comment}{*\ \ \ \ \ \ @endcode}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00024}00024\ \textcolor{comment}{*\ \ -\/\ Нельзя\ использовать\ переменные\ в\ качестве\ индекса:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00025}00025\ \textcolor{comment}{*\ \ \ \ \ \ @code}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00026}00026\ \textcolor{comment}{*\ \ \ \ \ \ \ \ uint8\_t\ i\ =\ 2;}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00027}00027\ \textcolor{comment}{*\ \ \ \ \ \ \ \ uint8\_bit(val,\ i);\ //\ Не\ сработает!}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00028}00028\ \textcolor{comment}{*\ \ \ \ \ \ @endcode}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00029}00029\ \textcolor{comment}{*\ \ -\/\ Макросы\ возвращают\ 0\ или\ 1.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00030}00030\ \textcolor{comment}{*\ \ -\/\ Доступ\ реализован\ через\ приведение\ к\ \`{}union`\ с\ битовыми\ полями,\ поэтому\ это}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00031}00031\ \textcolor{comment}{*\ \ \ \ безопасный\ способ\ работы\ с\ отдельными\ битами\ без\ ручного\ сдвига\ и\ маскирования.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00010}00010\ \textcolor{comment}{В\ этом\ файле\ определены\ макросы\ для\ получения\ значения\ конкретного\ бита\string^}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00011}00011\ \textcolor{comment}{-\/\ @ref\ uint8\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00012}00012\ \textcolor{comment}{-\/\ @ref\ uint16\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00013}00013\ \textcolor{comment}{-\/\ @ref\ uint32\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00014}00014\ \textcolor{comment}{-\/\ @ref\ uint64\_bit}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00015}00015\ \textcolor{comment}{}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00016}00016\ \textcolor{comment}{Особенности\ использования:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00017}00017\ \textcolor{comment}{-\/\ Индекс\ бита\ должен\ быть\ **константой\ на\ этапе\ компиляции**.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00018}00018\ \textcolor{comment}{\ \ Пример\ верного\ использования:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00019}00019\ \textcolor{comment}{\ \ \ \ @code}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00020}00020\ \textcolor{comment}{\ \ \ \ \ \ uint8\_t\ val\ =\ 0x05;}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00021}00021\ \textcolor{comment}{\ \ \ \ \ \ uint8\_t\ b2\ =\ uint8\_bit(val,\ 2);\ //\ Получить\ бит\ 2}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00022}00022\ \textcolor{comment}{\ \ \ \ \ \ uint8\_bit(val,\ 6)\ =\ 1;\ //\ Записать\ бит\ 6}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00023}00023\ \textcolor{comment}{\ \ \ \ @endcode}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00024}00024\ \textcolor{comment}{-\/\ Нельзя\ использовать\ переменные\ в\ качестве\ индекса:}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00025}00025\ \textcolor{comment}{\ \ \ \ @code}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00026}00026\ \textcolor{comment}{\ \ \ \ \ \ uint8\_t\ i\ =\ 2;}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00027}00027\ \textcolor{comment}{\ \ \ \ \ \ uint8\_bit(val,\ i);\ //\ Не\ сработает!}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00028}00028\ \textcolor{comment}{\ \ \ \ @endcode}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00029}00029\ \textcolor{comment}{-\/\ Макросы\ возвращают\ 0\ или\ 1.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00030}00030\ \textcolor{comment}{-\/\ Доступ\ реализован\ через\ приведение\ к\ \`{}union`\ с\ битовыми\ полями,\ поэтому\ это}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00031}00031\ \textcolor{comment}{\ \ безопасный\ способ\ работы\ с\ отдельными\ битами\ без\ ручного\ сдвига\ и\ маскирования.}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00032}00032\ \textcolor{comment}{*\ @\{}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00033}00033\ \textcolor{comment}{*************************************************************************/}}
|
||||
\DoxyCodeLine{\Hypertarget{bit__access_8h_source_l00034}00034\ \textcolor{preprocessor}{\#ifndef\ \_\_BIT\_ACCESS\_H\_}}
|
||||
|
||||
Reference in New Issue
Block a user