\doxysection{comps\+\_\+docpackage.\+h File Reference}
\hypertarget{comps__docpackage_8h}{}\label{comps__docpackage_8h}\index{comps\_docpackage.h@{comps\_docpackage.h}}


COMPS\+\_\+\+Doc\+Package header file.  


{\ttfamily \#include "{}comps\+\_\+utils.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+obj.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+log.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+validate.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+default.\+h"{}}\newline
\doxysubsubsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum \mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}} 
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docpackage_8h_a378b944c1e3651efdb61c3375102b580}{comps\+\_\+docpackage\+\_\+get\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg)
\item 
void \mbox{\hyperlink{comps__docpackage_8h_aaa69c9f5854186cfdb8d4c37bc76d594}{comps\+\_\+docpackage\+\_\+set\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg, char \texorpdfstring{$\ast$}{*}name, char copy)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docpackage_8h_ac75549fc89cb860092072e2cb7cd314a}{comps\+\_\+docpackage\+\_\+get\+\_\+requires}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg)
\item 
void \mbox{\hyperlink{comps__docpackage_8h_a715017ed4a1e35dad17be6b4113dbfef}{comps\+\_\+docpackage\+\_\+set\+\_\+requires}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg, char \texorpdfstring{$\ast$}{*}requires, char copy)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docpackage_8h_a250ae3816dbc6d8b1808ab5058e64f03}{comps\+\_\+docpackage\+\_\+get\+\_\+type}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg)
\item 
void \mbox{\hyperlink{comps__docpackage_8h_a94a0a0d03eddc8852cbb6c74277d6081}{comps\+\_\+docpackage\+\_\+set\+\_\+type}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg, \mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}} type, bool unset)
\item 
void \mbox{\hyperlink{comps__docpackage_8h_a1f13662b15df31ee0f3cdc975899c6c7}{comps\+\_\+docpackage\+\_\+set\+\_\+type\+\_\+i}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg, int type, bool unset)
\item 
const char \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docpackage_8h_a8041f01b09b9910fd19034a89c794e4f}{comps\+\_\+docpackage\+\_\+type\+\_\+str}} (\mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}} type)
\item 
void \mbox{\hyperlink{comps__docpackage_8h_a2abeacafdb5b101bbc43c7f843527e10}{comps\+\_\+docpackage\+\_\+set\+\_\+basearchonly}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg, int basearchonly, bool unset)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__docpackage_8h_a0157efc7ce4150d05f8a9b99fdeea448}{comps\+\_\+docpackage\+\_\+get\+\_\+basearchonly}} (\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}pkg)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
COMPS\+\_\+\+Doc\+Package header file. 



\label{doc-enum-members}
\Hypertarget{comps__docpackage_8h_doc-enum-members}
\doxysubsection{Enumeration Type Documentation}
\Hypertarget{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}\index{comps\_docpackage.h@{comps\_docpackage.h}!COMPS\_PackageType@{COMPS\_PackageType}}
\index{COMPS\_PackageType@{COMPS\_PackageType}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{COMPS\_PackageType}{COMPS\_PackageType}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e} 
enum \mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}}}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} type 

\label{doc-func-members}
\Hypertarget{comps__docpackage_8h_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{comps__docpackage_8h_a0157efc7ce4150d05f8a9b99fdeea448}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_get\_basearchonly@{comps\_docpackage\_get\_basearchonly}}
\index{comps\_docpackage\_get\_basearchonly@{comps\_docpackage\_get\_basearchonly}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_get\_basearchonly()}{comps\_docpackage\_get\_basearchonly()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a0157efc7ce4150d05f8a9b99fdeea448} 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} comps\+\_\+docpackage\+\_\+get\+\_\+basearchonly (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{}\end{DoxyParamCaption})}

return package basearchonly attrinute 
\begin{DoxyParams}{Parameters}
{\em type} & package type as \doxylink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\doxylink{structCOMPS__Num}{COMPS\+\_\+\+Num} basearchonly attribute 
\end{DoxyReturn}
\Hypertarget{comps__docpackage_8h_a378b944c1e3651efdb61c3375102b580}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_get\_name@{comps\_docpackage\_get\_name}}
\index{comps\_docpackage\_get\_name@{comps\_docpackage\_get\_name}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_get\_name()}{comps\_docpackage\_get\_name()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a378b944c1e3651efdb61c3375102b580} 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} comps\+\_\+docpackage\+\_\+get\+\_\+name (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} name getter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\doxylink{structCOMPS__Str}{COMPS\+\_\+\+Str} object typed as \doxylink{structCOMPS__Object}{COMPS\+\_\+\+Object} representating package\textquotesingle{}s name with incremented reference counter 
\end{DoxyReturn}
\Hypertarget{comps__docpackage_8h_ac75549fc89cb860092072e2cb7cd314a}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_get\_requires@{comps\_docpackage\_get\_requires}}
\index{comps\_docpackage\_get\_requires@{comps\_docpackage\_get\_requires}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_get\_requires()}{comps\_docpackage\_get\_requires()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_ac75549fc89cb860092072e2cb7cd314a} 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} comps\+\_\+docpackage\+\_\+get\+\_\+requires (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} requires getter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\doxylink{structCOMPS__Str}{COMPS\+\_\+\+Str} object typed as \doxylink{structCOMPS__Object}{COMPS\+\_\+\+Object} representating package\textquotesingle{}s requires attribute with incremented reference counter 
\end{DoxyReturn}
\Hypertarget{comps__docpackage_8h_a250ae3816dbc6d8b1808ab5058e64f03}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_get\_type@{comps\_docpackage\_get\_type}}
\index{comps\_docpackage\_get\_type@{comps\_docpackage\_get\_type}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_get\_type()}{comps\_docpackage\_get\_type()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a250ae3816dbc6d8b1808ab5058e64f03} 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} comps\+\_\+docpackage\+\_\+get\+\_\+type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} type getter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\doxylink{structCOMPS__Num}{COMPS\+\_\+\+Num} object typed as \doxylink{structCOMPS__Object}{COMPS\+\_\+\+Object} representating package\textquotesingle{}s type as number with incremented reference counter 
\end{DoxyReturn}
\Hypertarget{comps__docpackage_8h_a2abeacafdb5b101bbc43c7f843527e10}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_set\_basearchonly@{comps\_docpackage\_set\_basearchonly}}
\index{comps\_docpackage\_set\_basearchonly@{comps\_docpackage\_set\_basearchonly}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_set\_basearchonly()}{comps\_docpackage\_set\_basearchonly()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a2abeacafdb5b101bbc43c7f843527e10} 
void comps\+\_\+docpackage\+\_\+set\+\_\+basearchonly (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{, }\item[{int}]{basearchonly}{, }\item[{bool}]{unset}{}\end{DoxyParamCaption})}

set package basearchonly attribute 
\begin{DoxyParams}{Parameters}
{\em type} & package type as COMPS\+\_\+\+Pckage\+Type \\
\hline
{\em basearchonly} & basearchonly attribute \\
\hline
\end{DoxyParams}
\Hypertarget{comps__docpackage_8h_aaa69c9f5854186cfdb8d4c37bc76d594}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_set\_name@{comps\_docpackage\_set\_name}}
\index{comps\_docpackage\_set\_name@{comps\_docpackage\_set\_name}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_set\_name()}{comps\_docpackage\_set\_name()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_aaa69c9f5854186cfdb8d4c37bc76d594} 
void comps\+\_\+docpackage\+\_\+set\+\_\+name (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{, }\item[{char \texorpdfstring{$\ast$}{*}}]{name}{, }\item[{char}]{copy}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} name setter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
{\em name} & new name of package \\
\hline
{\em copy} & deprecated argument\\
\hline
\end{DoxyParams}
Old name object\textquotesingle{}s reference counter will be decremented \Hypertarget{comps__docpackage_8h_a715017ed4a1e35dad17be6b4113dbfef}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_set\_requires@{comps\_docpackage\_set\_requires}}
\index{comps\_docpackage\_set\_requires@{comps\_docpackage\_set\_requires}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_set\_requires()}{comps\_docpackage\_set\_requires()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a715017ed4a1e35dad17be6b4113dbfef} 
void comps\+\_\+docpackage\+\_\+set\+\_\+requires (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{, }\item[{char \texorpdfstring{$\ast$}{*}}]{requires}{, }\item[{char}]{copy}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} requires setter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
{\em requires} & new requries attribute value \\
\hline
{\em copy} & deprecated argument\\
\hline
\end{DoxyParams}
Old requires object\textquotesingle{}s reference counter will be decremented \Hypertarget{comps__docpackage_8h_a94a0a0d03eddc8852cbb6c74277d6081}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_set\_type@{comps\_docpackage\_set\_type}}
\index{comps\_docpackage\_set\_type@{comps\_docpackage\_set\_type}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_set\_type()}{comps\_docpackage\_set\_type()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a94a0a0d03eddc8852cbb6c74277d6081} 
void comps\+\_\+docpackage\+\_\+set\+\_\+type (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{, }\item[{\mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}}}]{type}{, }\item[{bool}]{unset}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} type setter 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
{\em type} & package type\\
\hline
\end{DoxyParams}
old object with stored type will be decremented \Hypertarget{comps__docpackage_8h_a1f13662b15df31ee0f3cdc975899c6c7}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_set\_type\_i@{comps\_docpackage\_set\_type\_i}}
\index{comps\_docpackage\_set\_type\_i@{comps\_docpackage\_set\_type\_i}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_set\_type\_i()}{comps\_docpackage\_set\_type\_i()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a1f13662b15df31ee0f3cdc975899c6c7} 
void comps\+\_\+docpackage\+\_\+set\+\_\+type\+\_\+i (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package}} \texorpdfstring{$\ast$}{*}}]{pkg}{, }\item[{int}]{type}{, }\item[{bool}]{unset}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} type setter same as comps\+\_\+docpackage\+\_\+set\+\_\+type 
\begin{DoxyParams}{Parameters}
{\em pkg} & \doxylink{structCOMPS__DocGroupPackage}{COMPS\+\_\+\+Doc\+Group\+Package} object \\
\hline
{\em type} & package type as integer \\
\hline
\end{DoxyParams}
\Hypertarget{comps__docpackage_8h_a8041f01b09b9910fd19034a89c794e4f}\index{comps\_docpackage.h@{comps\_docpackage.h}!comps\_docpackage\_type\_str@{comps\_docpackage\_type\_str}}
\index{comps\_docpackage\_type\_str@{comps\_docpackage\_type\_str}!comps\_docpackage.h@{comps\_docpackage.h}}
\doxysubsubsection{\texorpdfstring{comps\_docpackage\_type\_str()}{comps\_docpackage\_type\_str()}}
{\footnotesize\ttfamily \label{comps__docpackage_8h_a8041f01b09b9910fd19034a89c794e4f} 
const char \texorpdfstring{$\ast$}{*} comps\+\_\+docpackage\+\_\+type\+\_\+str (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type}}}]{type}{}\end{DoxyParamCaption})}

return package type as string 
\begin{DoxyParams}{Parameters}
{\em type} & package type as \doxylink{comps__docpackage_8h_ab1316a92e5193f11bf9e1a0d6f228a6e}{COMPS\+\_\+\+Package\+Type} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
string representation of type 
\end{DoxyReturn}
