From: David S. W. <dw...@us...> - 2008-04-09 21:34:15
|
Update of /cvsroot/xsb/XSB/packages/xsbdoc In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv15036 Modified Files: autodoc.P xsbdoc1.P Log Message: Made a few mostly small changes. Fixed some typos in the documentation. Ordered predicates in initial listing in a module alphabetically, and in the comment documentation by order of export (or document_export) instead of the random we were getting from trie-indexing. Caused the main file to be treated as a module (instead of an application) if it included a document_export. This was a simple way to get the documentation for the document_export-ed predicates in the main file to be generated. There may be a better way to do this.... Index: autodoc.P =================================================================== RCS file: /cvsroot/xsb/XSB/packages/xsbdoc/autodoc.P,v retrieving revision 1.17 retrieving revision 1.18 diff -u -r1.17 -r1.18 --- autodoc.P 8 Apr 2008 14:02:57 -0000 1.17 +++ autodoc.P 9 Apr 2008 21:34:11 -0000 1.18 @@ -75,12 +75,16 @@ clause_read(1, Body, Ctr):- '_#clause'(directive(Body),Ctr). -exports(F,A):- - '_#clause'(directive(document_export(Es)),_Ctr), +exports(F,A) :- % preserve order + setof(e(Ctr,F,A),exports(F,A,Ctr),ALL), + member(e(_,F,A),ALL). + +exports(F,A,Ctr):- + '_#clause'(directive(document_export(Es)),Ctr), comma_member(T,Es), T = F/ A. -exports(F,A):- - '_#clause'(directive(export(Es)),_Ctr), +exports(F,A,Ctr):- + '_#clause'(directive(export(Es)),Ctr), comma_member(T,Es), T = F/ A. @@ -245,6 +249,7 @@ _I,_Base,Dir,O,OS,CitStr,Opts), concat_atom([Dir,InputFile],MainIdx), detect_filetypes(Opts,Components,FileType,FileLevel), + writeln(userout,detect_filetypes(InputFile,Opts,Components,FileType,FileLevel)), document_front_matter(Format,FileType,FileLevel,Name,NDName,Dir, StartPage,PaperType,Idxs,Opts, @@ -409,7 +414,7 @@ # "Generates the documentation for the interface of a module.". %% --------------------------------------------------------------------------- -doc_interface(_,_,_FileLevel,FileType,_Base,_Name, +doc_interface(File,_,_FileLevel,FileType,_Base,_Name, _Idxs,_NOS,_IntroOS,_Opts):- ( FileType = application; FileType = part ), !. @@ -445,7 +450,8 @@ get_file_level_declarations(NDecls), - format_module_usage(Format,Name,RModuleType,Exports, + sort(Exports,SortedExports), + format_module_usage(Format,Name,RModuleType,SortedExports, UFiles,SysFiles,Ops,NDecls,Idxs,OS), % optional_message("Documenting (new) declarations...",Opts), % doc_decls(Name,NDecls,Base,Idxs,OS,Format,Opts), @@ -1076,6 +1082,7 @@ %% Application - no interface, so no complication detect_filetypes(Opts,Components,application,Level) :- member('-main',Opts), + \+exports(_,_), % check no exports or document_exports! !, optional_message('File being documented as an application',Opts), detect_filelevel(Opts,Components,Level). Index: xsbdoc1.P =================================================================== RCS file: /cvsroot/xsb/XSB/packages/xsbdoc/xsbdoc1.P,v retrieving revision 1.14 retrieving revision 1.15 diff -u -r1.14 -r1.15 --- xsbdoc1.P 8 Apr 2008 14:02:57 -0000 1.14 +++ xsbdoc1.P 9 Apr 2008 21:34:12 -0000 1.15 @@ -119,7 +119,7 @@ perform_generation_type(ascii,Main,List):- component_ascii([Main|List]), shell_list(['mv -f ',Main,'.ascii ',Main,'.tempascii']), - add_spaces([List],Spacelist), + add_spaces(List,Spacelist), shell_list(['cat ',Main,'.tempascii ',Spacelist,' > ',Main,'.ascii']). perform_generation_type(dvi,_,_). perform_generation_type(ps,Base,_):- @@ -155,7 +155,7 @@ component_html([]). component_html([P|T]):- corrected_search_module(P,_Dir,Base,_Src,_Isl), - shell_list(['csh texi2html -expandinfo -split_chapter -menu ', + shell_list(['sh texi2html -expandinfo -split_chapter -menu ', Base,'.texic']), component_html(T). @@ -206,7 +206,8 @@ findall(Val,xsbdoc_component(Val),Vals). shell_list(List) :- - shell(List). + concat_atom(List,AList), %shell doesn't use get_longstring, but parses list + shell(AList). make_bibfiles(Main):- shell_list(['chmod 664 ',Main,'.texic']), @@ -238,6 +239,7 @@ make_distclean:- shell('rm -f *.aux *.blg *.cp *.cps *.fn *.fns *.gl *.gls *.ky *.kys'), + shell('rm -f *.co *.cos *.op *.ops'), shell('rm -f *.log *.pd *.pds *.pg *.pgs *.refs *.texic *.toc '), shell('rm -f *.tp *.tps *.vr *.vrs'), shell('rm -f autodocXXXXXX *.tempascii'). @@ -259,7 +261,7 @@ appropriately read."). fix_if_cygwin(Dir0,Dir) :- - (configuration(architecture,i686-pc-cygwin), + (xsb_configuration(architecture,i686-pc-cygwin), atom_codes(Dir0,[Dr,0':'|Rest]) -> atom_codes(Dir,[0'/',Dr|Rest]) ; Dir = Dir0 |