\doxysection{comps\+\_\+docgroup.\+h File Reference}
\hypertarget{comps__docgroup_8h}{}\label{comps__docgroup_8h}\index{comps\_docgroup.h@{comps\_docgroup.h}}


\doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} header file.  


{\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\+\_\+docpackage.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+validate.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+radix.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+default.\+h"{}}\newline
{\ttfamily \#include $<$stddef.\+h$>$}\newline
{\ttfamily \#include $<$assert.\+h$>$}\newline
\doxysubsubsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga83e461454d96383f1a835b4253bc4e94}{comps\+\_\+docgroup\+\_\+set\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, char \texorpdfstring{$\ast$}{*}id, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga39f97f9a640868c3fae083a0e2461894}{comps\+\_\+docgroup\+\_\+set\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, char \texorpdfstring{$\ast$}{*}name, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga77a06d377911e1a0557ceaf4c7c91683}{comps\+\_\+docgroup\+\_\+set\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, char \texorpdfstring{$\ast$}{*}desc, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga4555ee506340a19d03b9f139a91595af}{comps\+\_\+docgroup\+\_\+set\+\_\+def}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, int def, bool unset)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_gadcef792ef9670747ebb3cd8034deab16}{comps\+\_\+docgroup\+\_\+set\+\_\+uservisible}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, int uservisible, bool unset)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga4d0e16aedb97e5261a197403b90b297f}{comps\+\_\+docgroup\+\_\+set\+\_\+biarchonly}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, int biarchonly, bool unset)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga8c7a048562881e4cd717a389a4d22960}{comps\+\_\+docgroup\+\_\+set\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, int display\+\_\+order, bool unset)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__prop__setters_ga25d8016cf584b1e789db6cfc55f8cdf7}{comps\+\_\+docgroup\+\_\+set\+\_\+langonly}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, char \texorpdfstring{$\ast$}{*}langonly, char copy)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_ga62194affe85f4c786f1d57f2a7362d15}{comps\+\_\+docgroup\+\_\+get\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_ga7dab9919dea8d7b956fb0253ca73b2c7}{comps\+\_\+docgroup\+\_\+get\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_gaa949f734f075ae8c6fdb26ec40637fa3}{comps\+\_\+docgroup\+\_\+get\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_ga997cb229dca9c2c285e76f857fdad389}{comps\+\_\+docgroup\+\_\+get\+\_\+def}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_gaad5778a34321ce34b377fa5523c6ecf4}{comps\+\_\+docgroup\+\_\+get\+\_\+uservisible}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_ga21fbb72b2a68b014bfc13da675f01030}{comps\+\_\+docgroup\+\_\+get\+\_\+biarchonly}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_ga88eeadc77e5715ec55db2c76d5575199}{comps\+\_\+docgroup\+\_\+get\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__prop__getters_gadd38c7a4773e7eecb92a5fddecff0b20}{comps\+\_\+docgroup\+\_\+get\+\_\+langonly}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group)
\item 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocGroup__list__getters_ga35959b9097c17db27e2016640a2d7349}{comps\+\_\+docgroup\+\_\+packages}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}obj)
\item 
void \mbox{\hyperlink{group__COMPS__DocGroup__list__setters_ga06d1134a21d8d7249c4204d4fc8bbbb9}{comps\+\_\+docgroup\+\_\+set\+\_\+packages}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}obj, \mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*}list)
\item 
void \mbox{\hyperlink{comps__docgroup_8h_ae9378b68e8e013c4af98d4008dc08bfa}{comps\+\_\+docgroup\+\_\+add\+\_\+package}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, \mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}package)
\item 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docgroup_8h_a3a6e6808b6cb3c0fb137f3f26f4dd1ab}{comps\+\_\+docgroup\+\_\+get\+\_\+packages}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}group, char \texorpdfstring{$\ast$}{*}name, \mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}} type)
\item 
\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docgroup_8h_ae3d251d0f475296e1859c265f307199a}{comps\+\_\+docgroup\+\_\+union}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}g1, \mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}g2)
\item 
\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docgroup_8h_aebc906ded34ffdf12628d926b562c6d1}{comps\+\_\+docgroup\+\_\+intersect}} (\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}g1, \mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}g2)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} header file. 

\begin{DoxySeeAlso}{See also}
\doxylink{group__COMPS__DocGroup__prop__setters}{COMPS\+\_\+\+Doc\+Group properties setters} 

\doxylink{group__COMPS__DocGroup__prop__getters}{COMPS\+\_\+\+Doc\+Group properties getters} 

\doxylink{group__COMPS__DocGroup__list__setters}{COMPS\+\_\+\+Doc\+Group list setters} 

\doxylink{group__COMPS__DocGroup__list__getters}{COMPS\+\_\+\+Doc\+Group list getters}
\end{DoxySeeAlso}
\doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object support union operation. Read more about \doxylink{}{Libcomps objects unioning } 

\label{doc-func-members}
\Hypertarget{comps__docgroup_8h_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{comps__docgroup_8h_ae9378b68e8e013c4af98d4008dc08bfa}\index{comps\_docgroup.h@{comps\_docgroup.h}!comps\_docgroup\_add\_package@{comps\_docgroup\_add\_package}}
\index{comps\_docgroup\_add\_package@{comps\_docgroup\_add\_package}!comps\_docgroup.h@{comps\_docgroup.h}}
\doxysubsubsection{\texorpdfstring{comps\_docgroup\_add\_package()}{comps\_docgroup\_add\_package()}}
{\footnotesize\ttfamily \label{comps__docgroup_8h_ae9378b68e8e013c4af98d4008dc08bfa} 
void comps\+\_\+docgroup\+\_\+add\+\_\+package (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{group}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{package}{}\end{DoxyParamCaption})}

add package to packages list in group 
\begin{DoxyParams}{Parameters}
{\em cat} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
{\em package} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
\end{DoxyParams}
\begin{DoxyWarning}{Warning}
\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} reference counter isn\textquotesingle{}t incremented 
\end{DoxyWarning}
\Hypertarget{comps__docgroup_8h_a3a6e6808b6cb3c0fb137f3f26f4dd1ab}\index{comps\_docgroup.h@{comps\_docgroup.h}!comps\_docgroup\_get\_packages@{comps\_docgroup\_get\_packages}}
\index{comps\_docgroup\_get\_packages@{comps\_docgroup\_get\_packages}!comps\_docgroup.h@{comps\_docgroup.h}}
\doxysubsubsection{\texorpdfstring{comps\_docgroup\_get\_packages()}{comps\_docgroup\_get\_packages()}}
{\footnotesize\ttfamily \label{comps__docgroup_8h_a3a6e6808b6cb3c0fb137f3f26f4dd1ab} 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} comps\+\_\+docgroup\+\_\+get\+\_\+packages (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{group}{, }\item[{char \texorpdfstring{$\ast$}{*}}]{name}{, }\item[{\mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}}}]{type}{}\end{DoxyParamCaption})}

return list of packages matching name and type name or type could be NULL and then doens\textquotesingle{}t affect search filter. Search doesn\textquotesingle{}t support any asterisk or dot notation like in regular expression 
\begin{DoxyParams}{Parameters}
{\em group} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
{\em name} & package name \\
\hline
{\em type} & package type \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
list of filtered packages 
\end{DoxyReturn}
\Hypertarget{comps__docgroup_8h_aebc906ded34ffdf12628d926b562c6d1}\index{comps\_docgroup.h@{comps\_docgroup.h}!comps\_docgroup\_intersect@{comps\_docgroup\_intersect}}
\index{comps\_docgroup\_intersect@{comps\_docgroup\_intersect}!comps\_docgroup.h@{comps\_docgroup.h}}
\doxysubsubsection{\texorpdfstring{comps\_docgroup\_intersect()}{comps\_docgroup\_intersect()}}
{\footnotesize\ttfamily \label{comps__docgroup_8h_aebc906ded34ffdf12628d926b562c6d1} 
\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*} comps\+\_\+docgroup\+\_\+intersect (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{g1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{g2}{}\end{DoxyParamCaption})}

intersect two groups into one and return new \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object 
\begin{DoxyParams}{Parameters}
{\em c1} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
{\em c2} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object 
\end{DoxyReturn}
\Hypertarget{comps__docgroup_8h_ae3d251d0f475296e1859c265f307199a}\index{comps\_docgroup.h@{comps\_docgroup.h}!comps\_docgroup\_union@{comps\_docgroup\_union}}
\index{comps\_docgroup\_union@{comps\_docgroup\_union}!comps\_docgroup.h@{comps\_docgroup.h}}
\doxysubsubsection{\texorpdfstring{comps\_docgroup\_union()}{comps\_docgroup\_union()}}
{\footnotesize\ttfamily \label{comps__docgroup_8h_ae3d251d0f475296e1859c265f307199a} 
\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*} comps\+\_\+docgroup\+\_\+union (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{g1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group}} \texorpdfstring{$\ast$}{*}}]{g2}{}\end{DoxyParamCaption})}

union two groups into one and return new \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object 
\begin{DoxyParams}{Parameters}
{\em g1} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
{\em g2} & \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocGroup}{COMPS\+\_\+\+Doc\+Group} object 
\end{DoxyReturn}
