Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Comparison between doc2 and master for reviewing #4

Open
wants to merge 79 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
b6f77f4
Adding mlis to libraries in bin/
Stevendeo Dec 2, 2021
c51e01a
Util.Utf8 documentation
hernoufM Dec 2, 2021
b7674e3
Utils.Name documentation
hernoufM Dec 2, 2021
605d35e
Util.Buff documentation
hernoufM Dec 3, 2021
45a7dd1
Merge branch 'doc' of github.com:OCamlPro/geneweb into doc
hernoufM Dec 3, 2021
6049131
[WIP] Def library documentation
hernoufM Dec 7, 2021
19ddd23
Util.Secure documentation
hernoufM Dec 8, 2021
ef997a0
Def.Adef documentation
hernoufM Dec 8, 2021
48fbc35
Util.Opt documentatio
hernoufM Dec 8, 2021
2b3788a
Document lib/util/secure.ml and bin/gwrepl/data.ml
Dec 4, 2021
25a5d35
Adding mlis and documentation
Stevendeo Dec 8, 2021
0ada197
Merge branch 'doc2' of github.com:OCamlPro/geneweb into docs2
hernoufM Dec 8, 2021
1287ad0
Util.Lock documentation
hernoufM Dec 9, 2021
ee4955f
Util.ProgrBar documentation
hernoufM Dec 10, 2021
a24df82
Util.Mutil documentation
hernoufM Dec 13, 2021
ea9be18
Adding types of hashtable in gwu
Stevendeo Dec 14, 2021
f227e70
Util.Calendar documentation
hernoufM Dec 14, 2021
59f0326
Util.Date documentation
hernoufM Dec 15, 2021
24f8b4b
Util.Pqueue documentation
hernoufM Dec 15, 2021
482a6f5
Util.Futil documentation
hernoufM Dec 15, 2021
37c489b
Gwdb-legacy.Btree documentation
hernoufM Dec 15, 2021
113fe80
mend
hernoufM Dec 16, 2021
96054a2
Merge branch 'doc2' of github.com:OCamlPro/geneweb into doc2
Stevendeo Dec 16, 2021
5e4156e
Gwc full documentation
hernoufM Dec 20, 2021
5679560
Merge branch 'doc2' of github.com:OCamlPro/geneweb into doc2
hernoufM Dec 20, 2021
d3c5281
Adding mli to GwuLib module
Stevendeo Dec 21, 2021
af70073
WiznotesDisplay documentation
Stevendeo Dec 21, 2021
479e084
Documenting the Wiki module
Stevendeo Dec 21, 2021
a374534
Documenting UpdateDataDisplay
Stevendeo Dec 21, 2021
7e3dcaa
Documentation of UpdateIndOk
Stevendeo Dec 22, 2021
3391d80
Documentation of UpdateFam
Stevendeo Dec 22, 2021
ca44eaf
Beginning of documentation of Util
Stevendeo Dec 22, 2021
d0c6218
Doc of updateInd
Stevendeo Dec 23, 2021
ca8fa52
Documentation of BirthdayDisplay
Stevendeo Dec 23, 2021
1e5713d
Documentation of AdvSearchOkDisplay
Stevendeo Dec 23, 2021
b0c860b
Documentation of CousinsDisplay
Stevendeo Dec 23, 2021
ba3227e
Documentation of DescendDisplay
Stevendeo Dec 23, 2021
9959898
Documentation of HistoryDiffDisplay
Stevendeo Dec 23, 2021
c91baed
Adding miscellaneous documentation
Stevendeo Dec 23, 2021
bdafb2d
Documentation of MergeIndDisplay
Stevendeo Dec 23, 2021
4588b70
Documentation of BirthDeathDisplay
Stevendeo Dec 23, 2021
085a631
Documentation of NotesDisplay
Stevendeo Dec 23, 2021
2a5872b
Documentation of MergeDupDisplay
Stevendeo Dec 23, 2021
c8c5700
Documenting MergeFamDisplay
Stevendeo Dec 23, 2021
1076263
Miscellanesous files and doc
Stevendeo Dec 23, 2021
afec298
Gwdb-legacy Documentation
hernoufM Dec 27, 2021
602135e
Merge branch 'doc2' of github.com:OCamlPro/geneweb into doc2
hernoufM Dec 27, 2021
b60c350
Gwdb documentation
hernoufM Dec 27, 2021
a1d8938
Core documentation
hernoufM Dec 28, 2021
2047cce
Show documentation
hernoufM Dec 28, 2021
5fdcd48
Ansel documentation
hernoufM Dec 29, 2021
a53e3db
Base64 documentation
hernoufM Dec 29, 2021
ce50f75
Check and CheckItem documentation
hernoufM Dec 30, 2021
7e8e8d0
Version documentation
hernoufM Dec 30, 2021
9dd6658
Stats documentation
hernoufM Dec 30, 2021
bf8963b
Fixbase documentation
hernoufM Dec 30, 2021
b0b8a39
Json_converter documentation
hernoufM Dec 31, 2021
8b7e100
Config and Output full documentation, almost finished GWPARAM, Hutil,…
hernoufM Jan 2, 2022
5007441
Added documentation to Util, Templ, GWPARAM, Hutil; started AdvSearchOk
hernoufM Jan 3, 2022
c680da0
Check of secure.ml should stop only when all prefixes have failed
Stevendeo Jan 7, 2022
639f289
AdvSearchOk documentation
hernoufM Jan 7, 2022
6263c2a
Alln and AllnDisplay documentation
hernoufM Jan 7, 2022
78d2595
Merge branch 'doc2' of github.com:OCamlPro/geneweb into doc2
hernoufM Jan 7, 2022
e395d74
Remove reference to Geneweb in mli
hernoufM Jan 7, 2022
3fb1619
Completing documentation for BirtdayDisplay, BirthDeathDisplay. Docum…
hernoufM Jan 9, 2022
c8672e6
ChangeChildren and ChangeChildrenDisplay documentation
hernoufM Jan 9, 2022
8289a40
Transfer Config documentation to mli file
hernoufM Jan 9, 2022
9bb0717
Documentation for Cousins and CousinsDisplay
hernoufM Jan 11, 2022
1938ec1
DAGs mlis
hernoufM Jan 11, 2022
8d4f140
DateDisplay documentation
hernoufM Jan 11, 2022
ce3cb4c
DescendDisplay documentation
hernoufM Jan 11, 2022
45efdf7
History, HistoryDiff and HistoryDiffDisplay documentation
hernoufM Jan 12, 2022
1657d50
ImageDisplay documentation
hernoufM Jan 12, 2022
2c3b978
MergeDisplay documentation
hernoufM Jan 12, 2022
60713ff
Interface to merge modules, Undocumented interfaces marked with TODOOCP
hernoufM Jan 12, 2022
fb3f19d
Sosa documentation
hernoufM Jan 16, 2022
3f14ff2
Developer documentation available with Generating hd/etc/version.txt.…
hernoufM Jan 18, 2022
77930ea
Clean repository from doc
hernoufM Jan 18, 2022
942b0a8
Adding to gitignore
hernoufM Jan 18, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ lib/gwlib.ml

# generated by Makefile
hd/etc/version.txt
*~
/_opam
doc/doc
14 changes: 13 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ endif
# Variables for packagers.
PREFIX=/usr
DISTRIB_DIR=distribution

BUILD_DIR=_build/default
ODOC_DIR=$(BUILD_DIR)/_doc/_html

DOC_DIR=doc

###### [BEGIN] Generated files section

Expand Down Expand Up @@ -174,8 +176,17 @@ distrib: build

doc: | $(GENERATED_FILES_DEP)
dune build @doc
if [ ! -d $(DOC_DIR)/doc ] ; then \
mkdir -p $(DOC_DIR)/doc ; \
cp -r $(ODOC_DIR)/* $(DOC_DIR)/doc ; \
fi
.PHONY: doc

opendoc : doc
xdg-open $(DOC_DIR)/html/dev-doc/index.html
.PHONY: opendoc


test: | $(GENERATED_FILES_DEP)
dune build @runtest
.PHONY: test
Expand All @@ -202,6 +213,7 @@ clean:
@echo -n "Cleaning..."
@$(RM) $(GENERATED_FILES_DEP) lib/*_piqi*.ml
@$(RM) -r $(DISTRIB_DIR)
@$(RM) -r $(DOC_DIR)/doc
@dune clean
@echo " Done!"
.PHONY: clean
Expand Down
4 changes: 2 additions & 2 deletions bin/ged2gwb/ged2gwb.ml
Original file line number Diff line number Diff line change
Expand Up @@ -2786,10 +2786,10 @@ let pass3 gen fname =
Some ('1'..'9') ->
Stream.junk strm__;
let (_ : string) = get_to_eoln 0 strm in loop ()
| Some _ ->
| Some c ->
Stream.junk strm__;
print_location !line_cnt;
Printf.fprintf !log_oc "Strange input.\n";
Printf.fprintf !log_oc "Strange input '%c' (%i).\n" c (Char.code c);
flush !log_oc;
let (_ : string) = get_to_eoln 0 strm in loop ()
| _ -> ()
Expand Down
11 changes: 11 additions & 0 deletions bin/gwb2ged/gwb2gedLib.mli
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
(** [gwb2ged with_indexes opts sel]
Converts a Geneweb database to a GEDCOM file.
* `with_indexes` specifies if indexes are printed or not;
* `opts` are the export options
* `sel` is a pair of selectors returned by the database export
*)
val gwb2ged :
bool ->
Gwexport.gwexport_opts ->
(Gwdb.iper -> bool) * (Gwdb.ifam -> bool)
-> unit
Loading