commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1242570 - in /commons/sandbox/graph/trunk/src/site/xdoc: index.xml model/ model/intro.xml
Date Thu, 09 Feb 2012 22:31:39 GMT
Author: simonetripodi
Date: Thu Feb  9 22:31:39 2012
New Revision: 1242570

some initial sparse doc

    commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml   (with props)

Modified: commons/sandbox/graph/trunk/src/site/xdoc/index.xml
--- commons/sandbox/graph/trunk/src/site/xdoc/index.xml (original)
+++ commons/sandbox/graph/trunk/src/site/xdoc/index.xml Thu Feb  9 22:31:39 2012
@@ -23,7 +23,10 @@
     <section name="The Graph Component">
-      <p>The Apache Commons Graph package is a Java library for managing graphs and
graph based data structures.</p>
+      <p>The Apache Commons Graph package is a Java library for managing
+      <a href="">Graph</a>
data structures, with strong emphasis on
+      Graph Algorithms and
+      <a href="">fluent APIs</a>.</p>
       <subsection name="Status">

Added: commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml
--- commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml (added)
+++ commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml Thu Feb  9 22:31:39 2012
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+<document xmlns="" xmlns:xsi=""
+  xsi:schemaLocation="">
+  <properties>
+    <title>Commons Graph - Getting started</title>
+    <author email="">Commons Documentation Team</author>
+  </properties>
+  <body>
+    <section name="Understanding the model">
+      <p>A <a href="../apidocs/org/apache/commons/graph/Graph.html">Graph</a>
data structure consists of a finite set of
+      ordered pairs, called <a href="../apidocs/org/apache/commons/graph/Edge.html">Edge</a>s
or arcs, of certain entity
+      called <a href="../apidocs/org/apache/commons/graph/Vertex.html">Vertex</a>
or node.</p>
+      <p>An <a href="../apidocs/org/apache/commons/graph/UndirectedGraph.html">UndirectedGraph</a>
is one in which edges
+      have no orientation. The edge <code>(a, b)</code> is identical to the edge
<code>(b, a)</code>, i.e., they are not
+      ordered pairs, but sets {u, v} (or 2-multisets) of vertices.</p>
+      <p>A <a href="../apidocs/org/apache/commons/graph/DirectedGraph.html">DirectedGraph</a>
is a Graph where an
+      edge <code>e = (a, b)</code> is considered to be directed from <code>a</code>
to <code>b</code>;
+      <code>a</code> is called the head and <code>b</code> is called
the tail of the arc.</p>
+    </section>
+  </body>

Propchange: commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml
    svn:eol-style = native

Propchange: commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml
    svn:keywords = Date Revision Author HeadURL Id

Propchange: commons/sandbox/graph/trunk/src/site/xdoc/model/intro.xml
    svn:mime-type = text/xml

View raw message