Avro
  1. Avro
  2. AVRO-37

Documentation now generated with Doxygen

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0.0
    • Component/s: c
    • Labels:
      None
    • Environment:

      Linux / MacOS X

      Description

      This patch will provide the following:

      commit 784477cc41ea1065fa5763ddcd9a99c9731b2406
      Author: matt <matt@cloudera.com>
      Date:   Fri May 22 15:08:28 2009 -0700
      
          Updated the build.xml to run doxygen on the C source
      
      :100644 100644 391f0bd... d673aae... M	build.xml
      
      commit 9654dc775d6fc660fef850584599d4fc23ff1610
      Author: matt <matt@cloudera.com>
      Date:   Fri May 22 11:27:50 2009 -0700
      
          Allow the C doxygen output directory to be set by an environment variable
      
      :100644 100644 73fcee2... 5e6e1f5... M	src/c/Makefile.am
      :100644 100644 8cf280f... e76bc87... M	src/c/avro.h
      :100644 100644 c1cd5dd... e7a63b4... M	src/c/docs/doxygen.conf
      
      commit e81c638d8d01196dba26172f45cee8b0237b79d8
      Author: matt <matt@cloudera.com>
      Date:   Sun May 17 20:11:02 2009 -0700
      
          Put back in the fix to allow C++ apps to use avro.h without extern "C"
      
      :100644 100644 fd3377a... 73fcee2... M	src/c/Makefile.am
      :100644 100644 daaa725... 8cf280f... M	src/c/avro.h
      
      commit 7e2886b30701237914fea4d9ffcb483732c6780d
      Author: matt <matt@cloudera.com>
      Date:   Sun May 17 20:09:16 2009 -0700
      
          Fixed small type warning for unit test
      
      :100644 100644 94b87db... 7d05c23... M	src/c/test_avro_float_double.c
      
      commit a8c8a9371923ff7360324a9ea7c45dd990ccf0f3
      Author: matt <matt@cloudera.com>
      Date:   Sun May 17 15:04:36 2009 -0700
      
          Stub for avro array function
      
      :000000 100644 0000000... 1908d17... A	src/c/avro_array.c
      
      commit cc4ecc14bf4e587ebf07ee0661b59391d7973fd8
      Author: matt <matt@cloudera.com>
      Date:   Fri May 15 23:53:43 2009 -0700
      
          Added documentation for avro array processing
      
      :100644 100644 01a922a... daaa725... M	src/c/avro.h
      
      commit 5e1e273afce80e7f0151234dd032cc80b36133a3
      Author: matt <matt@cloudera.com>
      Date:   Fri May 15 23:17:35 2009 -0700
      
          Update avro.h to be C++ friendly
      
      :100644 100644 c112423... 01a922a... M	src/c/avro.h
      
      commit bce6b06d0facf645d1f087714f9bee856d530082
      Author: matt <matt@cloudera.com>
      Date:   Thu May 14 17:53:17 2009 -0700
      
          First shot at adding file and socket backed Avro handles
      
      :100644 100644 3f2ff2d... d880e3f... M	src/c/avro_file.c
      :100644 100644 6fb66a5... 96e8ebb... M	src/c/avro_socket.c
      
      commit 92da91876343d5b7c90ddb95f169c014eda5e516
      Author: matt <matt@cloudera.com>
      Date:   Thu May 14 17:02:38 2009 -0700
      
          Updated to build clean Doxygen documentation on the C API
      
      :100644 100644 e1e8cd6... fd3377a... M	src/c/Makefile.am
      :100644 100644 f23b7e0... c112423... M	src/c/avro.h
      :000000 100644 0000000... c1cd5dd... A	src/c/docs/doxygen.conf
      
      commit 4a60bbc15bda5b1e85cb73e0b007d38a8e63f2a3
      Author: matt <matt@cloudera.com>
      Date:   Thu May 14 15:49:53 2009 -0700
      
          Ignore the INSTALL file
      
      :100644 100644 8f41889... 1e48c4a... M	src/c/.gitignore
      
      commit 745d43361dde448b1c8c42aa05a2528b76256ad0
      Author: matt <matt@cloudera.com>
      Date:   Thu May 14 14:47:56 2009 -0700
      
          Packaging the Avro C code should depend on test-c instead of compile-c
      
      :100644 100644 0228859... 391f0bd... M	build.xml
      
      1. AVRO-37.patch
        13 kB
        Matt Massie

        Activity

        Hide
        Doug Cutting added a comment -

        > I'm thinking (for example) of the "distcheck" target in autotools that requires all your unit tests pass before allowing you to package your software.

        I see how that could make sense. Perhaps we could add a test-and-package target, but if we do so we should do it for all languages and as a separate patch.

        > I kept getting errors about broken links.

        The example you provided doesn't link to an actual file. The file was c-api/html/index.html.

        I reorganized the API docs into doc/api/

        {c,java,py}

        , linked to all of these from forrest and committed this.

        Thanks, Matt!

        Show
        Doug Cutting added a comment - > I'm thinking (for example) of the "distcheck" target in autotools that requires all your unit tests pass before allowing you to package your software. I see how that could make sense. Perhaps we could add a test-and-package target, but if we do so we should do it for all languages and as a separate patch. > I kept getting errors about broken links. The example you provided doesn't link to an actual file. The file was c-api/html/index.html. I reorganized the API docs into doc/api/ {c,java,py} , linked to all of these from forrest and committed this. Thanks, Matt!
        Hide
        Matt Massie added a comment -

        I tried to add the C API to forrest but I kept getting errors. I've never used forrest before so I'm not sure exactly how to add it. Here was my naive attempted change to site.xml...

        <site label="Avro" href="" xmlns="http://apache.org/forrest/linkmap/1.0">
        
          <docs label="Documentation">
            <overview   label="Overview"          href="index.html" />
            <spec       label="Specification"     href="spec.html" />
            <api       label="API Docs"           href="ext:api/index" />
            <capi     label="C API Docs"    href="ext:c-api/index" />   
            <wiki      label="Wiki"               href="ext:wiki" />
            <faq       label="FAQ"                href="ext:faq" />
          </docs>
        
          <external-refs>
            <site      href="http://hadoop.apache.org/avro/"/>
            <lists     href="http://hadoop.apache.org/avro/mailing_lists.html"/>
            <archive   href="http://mail-archives.apache.org/mod_mbox/hadoop-avro-commits/"/>
            <releases  href="http://hadoop.apache.org/avro/releases.html">
              <download href="#Download" />
            </releases>
            <jira      href="http://hadoop.apache.org/avro/issue_tracking.html"/>
            <wiki      href="http://wiki.apache.org/hadoop/avro/" />
            <faq       href="http://wiki.apache.org/hadoop/avro/FAQ" />
            <json      href="http://www.json.org/" />
            <vint      href="http://lucene.apache.org/java/2_4_0/fileformats.html#VInt"/>
            <zigzag    href="http://code.google.com/apis/protocolbuffers/docs/encoding.html#types"/>
            <api href="api/">
              <index href="index.html" />
            </api>
            <c-api href="c-api/">
               <index href="index.html" />
           </c-api>
          </external-refs>
        </site>
        

        but I kept getting errors about broken links.

        Show
        Matt Massie added a comment - I tried to add the C API to forrest but I kept getting errors. I've never used forrest before so I'm not sure exactly how to add it. Here was my naive attempted change to site.xml ... <site label= "Avro" href= "" xmlns=" http: //apache.org/forrest/linkmap/1.0"> <docs label= "Documentation" > <overview label= "Overview" href= "index.html" /> <spec label= "Specification" href= "spec.html" /> <api label= "API Docs" href= "ext:api/index" /> <capi label= "C API Docs" href= "ext:c-api/index" /> <wiki label= "Wiki" href= "ext:wiki" /> <faq label= "FAQ" href= "ext:faq" /> </docs> <external-refs> <site href= "http: //hadoop.apache.org/avro/" /> <lists href= "http: //hadoop.apache.org/avro/mailing_lists.html" /> <archive href= "http: //mail-archives.apache.org/mod_mbox/hadoop-avro-commits/" /> <releases href= "http: //hadoop.apache.org/avro/releases.html" > <download href= "#Download" /> </releases> <jira href= "http: //hadoop.apache.org/avro/issue_tracking.html" /> <wiki href= "http: //wiki.apache.org/hadoop/avro/" /> <faq href= "http: //wiki.apache.org/hadoop/avro/FAQ" /> <json href= "http: //www.json.org/" /> <vint href= "http: //lucene.apache.org/java/2_4_0/fileformats.html#VInt" /> <zigzag href= "http: //code.google.com/apis/protocolbuffers/docs/encoding.html#types" /> <api href= "api/" > <index href= "index.html" /> </api> <c-api href= "c-api/" > <index href= "index.html" /> </c-api> </external-refs> </site> but I kept getting errors about broken links.
        Hide
        Matt Massie added a comment -

        I'm ok if this change is reverted.

        I'm thinking (for example) of the "distcheck" target in autotools that requires all your unit tests pass before allowing you to package your software. It's a nice check to make sure that you didn't forget to run tests before you built the package.

        Again, feel free to drop this change if you want.

        Show
        Matt Massie added a comment - I'm ok if this change is reverted. I'm thinking (for example) of the "distcheck" target in autotools that requires all your unit tests pass before allowing you to package your software. It's a nice check to make sure that you didn't forget to run tests before you built the package. Again, feel free to drop this change if you want.
        Hide
        Doug Cutting added a comment -

        Also, shouldn't we have the forrest docs link to the C docs, like they do to the Java docs?

        Show
        Doug Cutting added a comment - Also, shouldn't we have the forrest docs link to the C docs, like they do to the Java docs?
        Hide
        Doug Cutting added a comment -

        > Packaging the Avro C code should depend on test-c instead of compile-c

        I don't follow this. Creating the package shouldn't automatically run tests first, should it?

        Show
        Doug Cutting added a comment - > Packaging the Avro C code should depend on test-c instead of compile-c I don't follow this. Creating the package shouldn't automatically run tests first, should it?
        Hide
        Matt Massie added a comment -

        Here is the patch

        Show
        Matt Massie added a comment - Here is the patch
        Hide
        Matt Massie added a comment -

        Here is the patch

        Show
        Matt Massie added a comment - Here is the patch

          People

          • Assignee:
            Matt Massie
            Reporter:
            Matt Massie
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development