CodeVocabulary

Java

1. javadoc - Peter

Python

1. docutils / sphinx - Andrez

Perl

1. perldoc

PHP

1. php.net - Alex
2. phpdocumentor - Alex

C

1. gtk-doc - Dave

C++

1. doxygen - Linnea
2. tangle
3. web

Ruby

1. ruby-doc

Javascript

1. yui - Paul
2. jquery - Paul
3. dojo
4. prototype

Xquery

1. xqdoc - Micah

---

CodeVocabulary Ontology

Usage:

1. Find a function (name or description) in a language (in the code license)
2. Find a class (name or description) in a language (in the code license)
3. Description of method/class

CodeVocabulary Short Form Proposal

- hcodedoc
- language
 - version
- class
 - fn
 - description
 - member
  - fn
  - description

CodeVocabulary Long Form Proposal

- hcodedoc
- language
 - version
- environment
- package
 - fn
- sourcecode
- class abstractclass interface
 - super
 - sub
 - fn
 - description
 - summary
 - example
 - function classfunction constructor destructor
  - fn
  - description
  - return
   - description
   - type
  - param optionalparam
   - fn
   - description
   - position
   - type
   - default
 - attr classattr
  - fn
  - description
  - type

Term Definitions

hcodedoc

The head element of this microformat.

language

A lowercase string describing the language. Try to use the sourceforge.net name.

version

A dot separated value for the version number of language. Comparison is done by ascii character from left to right grouped by dots with a missing parameter being lowest in comparision. 42A.2 < 42D.2 < 42D.2a < 42D.2a.0

class

A root node for a object oriented "class".

member

Anything that is part of a class. Usually a function or a attribute. Might be part of the class (static) or instance.

fn

The name. Most often the identifier for this item.

description

A long piece of text that describe the parent element. If you aren't going to use the detailed elements, put the function prototype here.

environment

A string describing the execution environment. Free-form. Like "android/0.9", "pdo pdo_mysql".

package

A string describing your 

type

A string with the class name of the type. Usually used with an <a> element and an href="" to the returned class.

Things we didn't do

1. functional languages
2. accessors (public, private, protected)
3. exceptions