code documentation updates

doxygen now works again
more classes are left to be documented

.gitignore

@@ -43,7 +43,6 @@ bindings/ruby/freej_ruby.h
 *.*.swp
 core
 core.*
-doc/freej.dox
 doc/html
 doc/pydocstrings.i
 doc/xml

src/include/geometry.h

@@ -1,5 +1,5 @@
 /*  FreeJ
- *  (c) Copyright 2001-2009 Denis Roio aka jaromil <jaromil@dyne.org>
+ *  (c) Copyright 2001-2010 Denis Roio <jaromil@dyne.org>
  *
  * This source code is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Public License as published
@@ -22,10 +22,11 @@
 #include <inttypes.h>
 
 /**
-   This  class is  made to  hold  informations about  the geometry  of
-   Layers in FreeJ, describing their format and image bounds.
+   This class is made to hold informations about the geometry of
+   various video components in FreeJ, describing their format and
+   image bounds.
 
-   @brief geometrical specifications of layers
+   @brief Collects geometrical information about Layer, Screen and other components
 */
 class Geometry {
 

src/include/layer.h

@@ -1,5 +1,5 @@
 /*  FreeJ
- *  (c) Copyright 2001 Denis Roio aka jaromil <jaromil@dyne.org>
+ *  (c) Copyright 2001-2010 Denis Roio <jaromil@dyne.org>
  *
  * This source code is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Public License as published 
@@ -43,10 +43,6 @@ class ViewPort;
 class JSContext;
 
 
-/* function for type detection of implemented layers */
-//extern const char *layers_description;
-///< list of implemented layers to print in help
-
 /**
    This class describes methods and properties common to all Layers in
    FreeJ: it is the main interface for functionalities like blit
@@ -80,7 +76,7 @@ class JSContext;
    Geometrical informations about the layer:
    - Layer::geo
 
-   @brief Layer parent abstract class
+   @brief Provides input to the Context
 */
 class Layer: public Entry, public JSyncThread {
   friend class Blitter;

src/include/plugger.h

@@ -1,9 +1,9 @@
 /*  FreeJ
- *  (c) Copyright 2001 Denis Roio aka jaromil <jaromil@dyne.org>
+ *  (c) Copyright 2001-2010 Denis Roio <jaromil@dyne.org>
  *
  * This source code is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Public License as published 
- * by the Free Software Foundation; either version 2 of the License,
+ * by the Free Software Foundation; either version 3 of the License,
  * or (at your option) any later version.
  *
  * This source code is distributed in the hope that it will be useful,
@@ -39,6 +39,8 @@ class Context;
    It reads thru paths ($(prefix)/lib/freej and ~/.freej) looking for
    valid plugins and creates instances of them which are ready to be
    returned upon request to the host application of FreeJ controllers.
+
+   @brief Collects DLO plugins that can be used as Effect or Layer
 */
 class Plugger {
  public:

src/include/screen.h

@@ -17,6 +17,11 @@
  *
  */
 
+/**
+   @file screen.h
+   @brief FreeJ generic Screen interface
+*/
+
 #ifndef __SCREEN_H__
 #define __SCREEN_H__
 
@@ -76,6 +81,14 @@ class Layer;
 class Geometry;
 class VideoEncoder;
 
+/**
+   This class provides a generic interface common to all different
+   output screens present in FreeJ: its methods and properties are
+   affecting the visualization of mixed results in output.
+
+   @brief Output screen where results are visualized
+*/
+
 class ViewPort : public Entry {
   friend class Layer;
  public:

src/include/video_encoder.h

@@ -1,10 +1,10 @@
 /*  FreeJ
  *  (c) Copyright 2005 Silvano Galliani <kysucix@dyne.org>
- *                2007 Denis Rojo       <jaromil@dyne.org>
+ *                2007 Denis Roio       <jaromil@dyne.org>
  *
  * This source code is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Public License as published 
- * by the Free Software Foundation; either version 2 of the License,
+ * by the Free Software Foundation; either version 3 of the License,
  * or (at your option) any later version.
  *
  * This source code is distributed in the hope that it will be useful,
@@ -55,7 +55,7 @@ class ViewPort;
  *   - VideoEncoder::set_encoding_parameter
  *   - VideoEncoder::write_frame
  *
- * @brief Layer parent abstract class
+ * @brief Encodes output from Screen
 */