couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "couch_edocs" by mCoolin
Date Thu, 22 Mar 2012 02:43:02 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "couch_edocs" page has been changed by mCoolin:
http://wiki.apache.org/couchdb/couch_edocs?action=diff&rev1=5&rev2=6

Comment:
linked to daleharvey generated site for erldocs

  = COUCHDB edocs summary of modules =
  Please note this is a work in progress but over the next few days I hope to have all sections
and modules documentation posted here.
- <<TableOfContents()>>
- == couchdb ==
- === Module couch_util ===
- ==== Function Details ====
- ===== abs_pathname/1 =====
- {{{abs_pathname(Filename) -> any()}}}
  
- ===== abs_pathname/2 =====
- {{{abs_pathname(Filename, Dir) -> any()}}}
+ == comment suggestions ==
+  * module comments (more to come)
+  * function comments (more to come)
  
- ===== collate/2 =====
- {{{collate(A, B) -> any()}}}
+ == link to generated documentation ==
+ [[http://couch.erldocs.com/| couch erldocs]]
  
- ===== collate/3 =====
- {{{collate(A, B, Options) -> any()}}}
- 
- ===== decodeBase64Url/1 =====
- {{{decodeBase64Url(Url64) -> any()}}}
- 
- ===== dict_find/3 =====
- {{{dict_find(Key, Dict, DefaultValue) -> any()}}}
- 
- ===== encodeBase64Url/1 =====
- {{{encodeBase64Url(Url) -> any()}}}
- 
- ===== encode_doc_id/1 =====
- {{{encode_doc_id(Doc) -> any()}}}
- 
- ===== get_nested_json_value/2 =====
- {{{get_nested_json_value(Value, Keys) -> any()}}}
- 
- ===== get_value/2 =====
- {{{get_value(Key, List) -> any()}}}
- 
- ===== get_value/3 =====
- {{{get_value(Key, List, Default) -> any()}}}
- 
- ===== implode/2 =====
- {{{implode(List, Sep) -> any()}}}
- 
- ===== json_apply_field/2 =====
- {{{json_apply_field(H, X2) -> any()}}}
- 
- ===== json_user_ctx/1 =====
- {{{json_user_ctx(Db) -> any()}}}
- 
- ===== md5/1 =====
- {{{md5(Data::(iolist() | binary())) -> Digest::binary()}}}
- 
- ===== md5_final/1 =====
- {{{md5_final(Context::binary()) -> Digest::binary()}}}
- 
- ===== md5_init/0 =====
- {{{md5_init() -> Context::binary()}}}
- 
- ===== md5_update/2 =====
- {{{md5_update(Context::binary(), Data::(iolist() | binary())) -> NewContext::binary()}}}
- 
- ===== normpath/1 =====
- {{{normpath(Path) -> any()}}}
- 
- ===== parse_term/1 =====
- {{{parse_term(Bin) -> any()}}}
- 
- ===== priv_dir/0 =====
- {{{priv_dir() -> any()}}}
- 
- ===== proplist_apply_field/2 =====
- {{{proplist_apply_field(H, L) -> any()}}}
- 
- ===== rand32/0 =====
- {{{rand32() -> any()}}}
- 
- ===== reorder_results/2 =====
- {{{reorder_results(Keys, SortedResults) -> any()}}}
- 
- ===== should_flush/0 =====
- {{{should_flush() -> any()}}}
- 
- ===== should_flush/1 =====
- {{{should_flush(MemThreshHold) -> any()}}}
- 
- ===== shutdown_sync/1 =====
- {{{shutdown_sync(Pid) -> any()}}}
- 
- ===== simple_call/2 =====
- {{{simple_call(Pid, Message) -> any()}}}
- 
- ===== to_binary/1 =====
- {{{to_binary(V) -> any()}}}
- 
- ===== to_existing_atom/1 =====
- {{{to_existing_atom(V) -> any()}}}
- 
- ===== to_hex/1 =====
- {{{to_hex(Bin) -> any()}}}
- 
- ===== to_integer/1 =====
- {{{to_integer(V) -> any()}}}
- 
- ===== to_list/1 =====
- {{{to_list(V) -> any()}}}
- 
- ===== trim/1 =====
- {{{trim(String) -> any()}}}
- 
- ===== url_encode/1 =====
- {{{url_encode(Bin) -> any()}}}
- 
- ===== url_strip_password/1 =====
- {{{url_strip_password(Url) -> any()}}}
- 
- ===== validate_utf8/1 =====
- {{{validate_utf8(Data) -> any()}}}
- 
- ===== verify/2 =====
- {{{verify(X, Y) -> any()}}}
- 
- ===== with_db/2 =====
- {{{with_db(Db, Fun) -> any()}}}
- 
- == couch_index ==
- == courch_mrview ==
- == couch_replicator ==
- == ejson ==
- == erlang-oauth ==
- == etap ==
- == ibrowse ==
- == mochiweb ==
- == snappy ==
- 

Mime
View raw message