Add doc folder

ubuntuslave · May 24, 2013 · 23268e6 · 23268e6
1 parent 5f9c6e5
commit 23268e6
Show file tree

Hide file tree

Showing 356 changed files with 21,844 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,6 @@
 *.o
 *.bak
 *.pgm
-doc
 .project
 .cproject
-Debug
+Debug
diff --git a/doc/html/annotated.html b/doc/html/annotated.html
@@ -0,0 +1,116 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<title>CACAtalk: Class List</title>
+
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div! -->
+
+
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+
+
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">CACAtalk
+   &#160;<span id="projectnumber">1.0</span>
+   </div>
+
+  </td>
+
+
+
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<!-- Generated by Doxygen 1.7.6.1 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div id="navrow2" class="tabs2">
+    <ul class="tablist">
+      <li class="current"><a href="annotated.html"><span>Class&#160;List</span></a></li>
+      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="header">
+  <div class="headertitle">
+<div class="title">Class List</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><table>
+  <tr><td class="indexkey"><a class="el" href="struct__window.html">_window</a></td><td class="indexvalue">A Window structure encapsulates the dimensions of the window and the amount by which the text within it has been scrolled. The line_at_top member is the lowest index of all lines in the text buffer that is currently visible in the window, i.e., the index of the top line on the screen. Only complete lines are displayed, so line_at_top is the index of the line whose entire contents are visible </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structbuffer.html">buffer</a></td><td class="indexvalue">A buffer place holder to be used with video streaming buffers given by the v4l device </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structimage.html">image</a></td><td class="indexvalue">An image object to indicate the corresponding pixels of a video buffer in memory and other parameters, such as widht, height (pixels) and the caca dither format of choice </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structoptions__s.html">options_s</a></td><td class="indexvalue">This structure stores the argument options needed across the program. It will be called from a few different places if modification/setting of an member argument is needed </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structtextentry.html">textentry</a></td><td class="indexvalue">A buffer for text entry as uint32 characters used for putting characters in caca canvas </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structvideo__out__args__s.html">video_out_args_s</a></td><td class="indexvalue">Structure of arguments passed to a thread (also is going to be made global to be able to shut the video on and off) </td></tr>
+  <tr><td class="indexkey"><a class="el" href="structvideo__params__s.html">video_params_s</a></td><td class="indexvalue">This structure stores the video device parameters that are used for streaming video frames with V4L2 </td></tr>
+</table>
+</div><!-- contents -->
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Defines</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+
+
+<hr class="footer"/><address class="footer"><small>
+Generated on Fri May 24 2013 16:06:42 for CACAtalk by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.7.6.1
+</small></address>
+
+</body>
+</html>
diff --git a/doc/html/bc_s.png b/doc/html/bc_s.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ @@
     *.o
     *.bak
     *.pgm
-    doc
     .project
     .cproject
-    Debug
+    Debug