\doxysection{comps\+\_\+docenv.\+h File Reference}
\hypertarget{comps__docenv_8h}{}\label{comps__docenv_8h}\index{comps\_docenv.h@{comps\_docenv.h}}


\doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} header file.  


{\ttfamily \#include $<$stddef.\+h$>$}\newline
{\ttfamily \#include $<$assert.\+h$>$}\newline
{\ttfamily \#include "{}comps\+\_\+utils.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+obj.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+objdict.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+objlist.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+docgroupid.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+validate.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+radix.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+log.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+default.\+h"{}}\newline
\doxysubsubsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__prop__setters_ga90e8c5bd476910bcb488de0481a29633}{comps\+\_\+docenv\+\_\+set\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, char \texorpdfstring{$\ast$}{*}id, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__prop__setters_ga9d2a11b3d4b2d9b475fbc8f941899be1}{comps\+\_\+docenv\+\_\+set\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, char \texorpdfstring{$\ast$}{*}name, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__prop__setters_ga6e18dabf3a78b68cb380b783ef053db2}{comps\+\_\+docenv\+\_\+set\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, char \texorpdfstring{$\ast$}{*}desc, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__prop__setters_ga5f349e8d788a7f19d69c1fa16d5a55a6}{comps\+\_\+docenv\+\_\+set\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, int display\+\_\+order, bool unset)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__prop__getters_ga041dac32384a33bd7a4e8422c0987a5e}{comps\+\_\+docenv\+\_\+get\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__prop__getters_gaa953bbe85e52a9c2a470cea90a6bc388}{comps\+\_\+docenv\+\_\+get\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__prop__getters_ga7d63a3056b3841a3e15cf69e2f8ae0e6}{comps\+\_\+docenv\+\_\+get\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__prop__getters_gaf915e745ee06398b6ca48d57d561ebac}{comps\+\_\+docenv\+\_\+get\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env)
\item 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__list__getters_ga9c4fc524f33d090f19653235f2d46a84}{comps\+\_\+docenv\+\_\+group\+\_\+list}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}obj)
\item 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocEnv__list__getters_gaf39e7744b2cf6e0e4aa446e115b043ed}{comps\+\_\+docenv\+\_\+option\+\_\+list}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}obj)
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__list__setters_gad101e59acdb09af2d378b18f77dc8762}{comps\+\_\+docenv\+\_\+set\+\_\+group\+\_\+list}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}obj, \mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*}list)
\item 
void \mbox{\hyperlink{group__COMPS__DocEnv__list__setters_gac97ac46dea23649271666a55ebf9ebfa}{comps\+\_\+docenv\+\_\+set\+\_\+option\+\_\+list}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}obj, \mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*}list)
\item 
void \mbox{\hyperlink{comps__docenv_8h_af55641e7ba092ce00e70b01202476606}{comps\+\_\+docenv\+\_\+add\+\_\+groupid}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, \mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}gid)
\item 
void \mbox{\hyperlink{comps__docenv_8h_aa347bf3f0f4786afb5b4e5f6ba666832}{comps\+\_\+docenv\+\_\+add\+\_\+optionid}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}env, \mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}gid)
\item 
\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docenv_8h_a5f7b0f1e7843e5b0033bf635f250eabd}{comps\+\_\+docenv\+\_\+union}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}e1, \mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}e2)
\item 
\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docenv_8h_abc909f3ae873102b11b61d493a74a50f}{comps\+\_\+docenv\+\_\+intersect}} (\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}e1, \mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}e2)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} header file. 

\begin{DoxySeeAlso}{See also}
\doxylink{group__COMPS__DocEnv__prop__setters}{COMPS\+\_\+\+Doc\+Env properties setters} 

\doxylink{group__COMPS__DocEnv__prop__getters}{COMPS\+\_\+\+Doc\+Env properties getters} 

\doxylink{group__COMPS__DocEnv__list__setters}{COMPS\+\_\+\+Doc\+Env list setters} 

\doxylink{group__COMPS__DocEnv__list__getters}{COMPS\+\_\+\+Doc\+Env list getters}
\end{DoxySeeAlso}
\doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object support union operation. Read more about \doxylink{}{Libcomps objects unioning } 

\label{doc-func-members}
\Hypertarget{comps__docenv_8h_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{comps__docenv_8h_af55641e7ba092ce00e70b01202476606}\index{comps\_docenv.h@{comps\_docenv.h}!comps\_docenv\_add\_groupid@{comps\_docenv\_add\_groupid}}
\index{comps\_docenv\_add\_groupid@{comps\_docenv\_add\_groupid}!comps\_docenv.h@{comps\_docenv.h}}
\doxysubsubsection{\texorpdfstring{comps\_docenv\_add\_groupid()}{comps\_docenv\_add\_groupid()}}
{\footnotesize\ttfamily \label{comps__docenv_8h_af55641e7ba092ce00e70b01202476606} 
void comps\+\_\+docenv\+\_\+add\+\_\+groupid (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{env}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}}]{gid}{}\end{DoxyParamCaption})}

add group\+\_\+id to group\+\_\+ids list in environment 
\begin{DoxyParams}{Parameters}
{\em env} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
{\em gid} & \doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} object \\
\hline
\end{DoxyParams}
\begin{DoxyWarning}{Warning}
\doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} reference counter isn\textquotesingle{}t incremented 
\end{DoxyWarning}
\Hypertarget{comps__docenv_8h_aa347bf3f0f4786afb5b4e5f6ba666832}\index{comps\_docenv.h@{comps\_docenv.h}!comps\_docenv\_add\_optionid@{comps\_docenv\_add\_optionid}}
\index{comps\_docenv\_add\_optionid@{comps\_docenv\_add\_optionid}!comps\_docenv.h@{comps\_docenv.h}}
\doxysubsubsection{\texorpdfstring{comps\_docenv\_add\_optionid()}{comps\_docenv\_add\_optionid()}}
{\footnotesize\ttfamily \label{comps__docenv_8h_aa347bf3f0f4786afb5b4e5f6ba666832} 
void comps\+\_\+docenv\+\_\+add\+\_\+optionid (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{env}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}}]{gid}{}\end{DoxyParamCaption})}

add group\+\_\+id to option list in environment 
\begin{DoxyParams}{Parameters}
{\em env} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
{\em gid} & \doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} object \\
\hline
\end{DoxyParams}
\begin{DoxyWarning}{Warning}
\doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} reference counter isn\textquotesingle{}t incremented 
\end{DoxyWarning}
\Hypertarget{comps__docenv_8h_abc909f3ae873102b11b61d493a74a50f}\index{comps\_docenv.h@{comps\_docenv.h}!comps\_docenv\_intersect@{comps\_docenv\_intersect}}
\index{comps\_docenv\_intersect@{comps\_docenv\_intersect}!comps\_docenv.h@{comps\_docenv.h}}
\doxysubsubsection{\texorpdfstring{comps\_docenv\_intersect()}{comps\_docenv\_intersect()}}
{\footnotesize\ttfamily \label{comps__docenv_8h_abc909f3ae873102b11b61d493a74a50f} 
\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*} comps\+\_\+docenv\+\_\+intersect (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{e1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{e2}{}\end{DoxyParamCaption})}

intersect two environments into one and return new \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object 
\begin{DoxyParams}{Parameters}
{\em e1} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
{\em e2} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object 
\end{DoxyReturn}
\Hypertarget{comps__docenv_8h_a5f7b0f1e7843e5b0033bf635f250eabd}\index{comps\_docenv.h@{comps\_docenv.h}!comps\_docenv\_union@{comps\_docenv\_union}}
\index{comps\_docenv\_union@{comps\_docenv\_union}!comps\_docenv.h@{comps\_docenv.h}}
\doxysubsubsection{\texorpdfstring{comps\_docenv\_union()}{comps\_docenv\_union()}}
{\footnotesize\ttfamily \label{comps__docenv_8h_a5f7b0f1e7843e5b0033bf635f250eabd} 
\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*} comps\+\_\+docenv\+\_\+union (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{e1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env}} \texorpdfstring{$\ast$}{*}}]{e2}{}\end{DoxyParamCaption})}

union two environments into one and return new \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object 
\begin{DoxyParams}{Parameters}
{\em e1} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
{\em e2} & \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocEnv}{COMPS\+\_\+\+Doc\+Env} object 
\end{DoxyReturn}
