Author: visnov Date: Tue Sep 30 21:47:37 2008 New Revision: 51718

URL: http://svn.opensuse.org/viewcvs/yast?rev=51718&view=rev Log: very basic libycp documentation

Modified: trunk/core/liby2/src/include/y2/Y2Component.h trunk/core/libycp/src/include/YCP.h trunk/core/libycp/src/include/ycp/YCode.h

Modified: trunk/core/liby2/src/include/y2/Y2Component.h URL: http://svn.opensuse.org/viewcvs/yast/trunk/core/liby2/src/include/y2/Y2Compo... ============================================================================== --- trunk/core/liby2/src/include/y2/Y2Component.h (original) +++ trunk/core/liby2/src/include/y2/Y2Component.h Tue Sep 30 21:47:37 2008 @@ -88,8 +88,7 @@ * defined protocol. Both the language and the protocol are * called <i>YCP (YaST2 communication protocol)</i>. One protocol * step consists of one of the partners sending exactly one - * <a href="../libycp/YCP-datatypes.html">YCP value</a> - * to the other and the other receiving that value. In the + * of \ref ycpvalues to the other and the other receiving that value. In the * next step, the component that just was receiving, is now sending and * vice versa. The only exception is, that one of that partners * may terminate the session and send a last <i>result</i> message @@ -136,8 +135,7 @@ * <ul> * * <li>An executable program (ELF, /bin/sh, or whatsoever)</li> - * <li>A C++ class using <tt><a href="../libycp/autodocs/intro.html">libycp</a></tt> - * and \ref liby2</li> + * <li>A C++ class using \ref libycp and \ref liby2</li> * <li>A YCP script executed by the <i>Workflowmanager</i></li> * <li>Youself typing some YCP code at a terminal</li> * @@ -159,8 +157,7 @@ * <p>The data flowing through these pipes is YCP Ascii * representation. Each communication side needs a parser to analyse the * data and a YCP syntax generater to write data to the pipe. Both can be - * found in the <tt><a href="../libycp/autodocs/intro.html">libycp</a></tt>, - * which can only used from C++ programs. + * found in the \ref libycp, which can only used from C++ programs. * * <p>But the production of YCP code * can in many cases very easily be done be printing to stdout, for @@ -178,8 +175,7 @@ * component implementation. * * <p>What you have to do is to subclass at least two classes: - * <tt><a href="../liby2/autodocs/Y2ComponentCreator.html">Y2ComponentCreator</a></tt> and - * <tt><a href="../liby2/autodocs/Y2Component.html">Y2Component</a></tt> and + * \ref Y2ComponentCreator and \ref Y2Component and * * <p>Depending on whether you want to implement a server or a client component * you have to override different methods. Many examples can be found within the liby2

Modified: trunk/core/libycp/src/include/YCP.h URL: http://svn.opensuse.org/viewcvs/yast/trunk/core/libycp/src/include/YCP.h?rev... ============================================================================== --- trunk/core/libycp/src/include/YCP.h (original) +++ trunk/core/libycp/src/include/YCP.h Tue Sep 30 21:47:37 2008 @@ -29,6 +29,12 @@ // include all basic types

/** + * \page libycp libycp Library + * + * This is a library implementing basic \ref ycpvalues and \ref ycplanguage. + */ + +/** * \page ycpvalues YCP Values * * YCP values are the primary way of communicating of YaST components. The following values are implemented:

Modified: trunk/core/libycp/src/include/ycp/YCode.h URL: http://svn.opensuse.org/viewcvs/yast/trunk/core/libycp/src/include/ycp/YCode... ============================================================================== --- trunk/core/libycp/src/include/ycp/YCode.h (original) +++ trunk/core/libycp/src/include/ycp/YCode.h Tue Sep 30 21:47:37 2008 @@ -21,6 +21,16 @@ #ifndef YCode_h #define YCode_h

+/** + * \page ycplanguage YCP Scripting Language + * \todo Enhance + * + * YCP is a very simple imperative scripting language with builtin support for + * \ref ycpvalues, easy access to \ref components, common control structures and more. + * It is designed to be well suited for system configuration manipulation. + * + */ + #include <string> using std::string;