#13 build_html.sh don't compile docs

v1.0_(example)
closed
None
5
2014-10-19
2013-10-15
AlexL
No

./build_html.sh
FPDoc - Free Pascal Documentation Tool
Version 2.6.2 [2013/07/07]
(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org

exception at 08081A45:
Unable to open file "xml/corelib/fpg_cmdlineparams.xml".

Discussion

  • StrPt

    StrPt - 2014-10-15

    ./build_html.sh
    Parsing used unit "fpg_constants" with commandLine "-Fi../src/corelib ../src/corelib/fpg_constants.pas"
    ../src/corelib/fpg_constants.pas(0,0): Could not find include file 'VERSION_FILE.inc'
    Parsing used unit "fpg_button" with commandLine "-Fi../src/gui ../src/gui/fpg_button.pas"
    Parsing used unit "fpg_tree" with commandLine "-Fi../src/gui ../src/gui/fpg_tree.pas"
    Parsing used unit "fpg_ColorWheel" with commandLine "-Fi../src/gui ../src/gui/fpg_colorwheel.pas"
    Writing 2348 pages...
    Warning: Target ID of <linFPDoc - Free Pascal Documentation Tool
    Version 2.6.4 [2014/10/01]
    (c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
    (c) 2005 - 2012 various FPC contributors

    exception at 080BA37F:
    [example] File not found.
    k> in unit "fpg_base", element "TFPColor", is unknown: "fpg_base.TRGBTripple"

     
  • StrPt

    StrPt - 2014-10-15

    ./build_html.sh
    Parsing used unit "fpg_constants" with commandLine "-Fi../src/corelib ../src/corelib/fpg_constants.pas"
    ../src/corelib/fpg_constants.pas(0,0): Could not find include file 'VERSION_FILE.inc'
    Parsing used unit "fpg_button" with commandLine "-Fi../src/gui ../FPDoc - Free Pascal Documentation Tool
    Version 2.6.2 [2013/07/07]
    (c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org

    exception at 080BA38F:
    [example] File not found.
    src/gui/fpg_button.pas"
    Parsing used unit "fpg_tree" with commandLine "-Fi../src/gui ../src/gui/fpg_tree.pas"
    Parsing used unit "fpg_ColorWheel" with commandLine "-Fi../src/gui ../src/gui/fpg_colorwheel.pas"
    Writing 2347 pages...

     
  • StrPt

    StrPt - 2014-10-18

    Workaround:
    1) cp -f ./src/VERSION_FILE.inc ./src/corelib/
    2) there is patch in attachement

    But it's partial fix:

    Warning: Target ID of <link> in unit "fpg_main", element "?", is unknown: "fpg_edit.TfpgEdit"
    Warning: Target ID of <link> in unit "fpg_constants", element "?", is unknown: "#fpgui.AdditionalTopics.ChangingDefaultLanguage"
    Warning: Target ID of <link> in unit "fpg_widget", element "InvokeHelp", is unknown: "fpg_main.TfpgApplication.HelpFile"
    Warning: Target ID of <link> in unit "fpg_tree", element "TfpgTreeNode", is unknown: "fpgui.fpg_tree.TfpgTreeView"
    Warning: Target ID of <link> in unit "fpg_tree", element "TfpgTreeView", is unknown: "fpgui.fpg_tree.TfpgTreeNode"
    Warning: Target ID of <link> in unit "fpg_tree", eFPDoc - Free Pascal Documentation Tool
    Version 2.6.4 [2014/10/01]
    (c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
    (c) 2005 - 2012 various FPC contributors

    Done.
    lement "?", is unknown: "#fpgui.fpg_tree.TfpgTreeview.FondDesc"

     
  • Graeme Geldenhuys

    • assigned_to: Graeme Geldenhuys
     
  • Graeme Geldenhuys

    Thanks for raising the issue and suggesting a patch. The build_*.sh scripts are obsolete and meant to be deleted (which I have now done in commit 1a933103).

    The preferred method is to simply use fpdoc and the documentation
    project (XML) file.

    eg:
    fpdoc --project=fpgui-docs-project.xml

    The XML project file contains INF output format as default, but the
    other settings like HTML, RTF etc are included, just commented.

     
  • Graeme Geldenhuys

    • status: open --> closed
     
  • StrPt

    StrPt - 2014-10-19

    Will you continue support html format for docs, it's good to have htmls in RPM package in doc dir for fpgui? fpdoc is not alternative.

     
  • Graeme Geldenhuys

    Yes of course. The fpdoc XML project file is just a much more simplified way to setup the docs and output formats. No need for bash scripts or extremely long command line parameters. If you want to generate your own HTML docs of fpGUI, simply edit the fpgui-docs-project.xml file. Change the output="fpgui.ipf" to read "output="html/". Then further down the file change the "format" line to read value="html"

    You will see the .xml file already has all the settings defined for the various output formats - they are just commented out.

    I also host the latest fpGUI HTML docs online on the fpGUI Toolkit website:
    http://fpgui.sourceforge.net/apidocs/index.html

    fpdoc is a documentation tool include with FPC. It allows you to generate different output formats from the same set of source code and help contents. As I mentioned, I generate HTML output for the website, but use INF format for offline usage. The INF format (viewed with DocView) also allows advanced searching, opening multiple INF file at the same time, allows bookmarks, inline comments etc... All things the HTML format cannot do.

     
  • StrPt

    StrPt - 2014-10-19

    I need command line tool only. Html files creates while building RPM package. I used script build_html.sh.

     
  • Graeme Geldenhuys

    Then simply use: fpdoc --project=fpgui-docs-project.xml

    fpdoc is a command line tool, and is what build_html.sh called anyway.

    DocView is the fpGUI Documentation Viewer.

     
  • StrPt

    StrPt - 2014-10-19

    fpdoc --project=fpgui-docs-project.xml
    Parsing used unit "fpg_scrollbar" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_scrollbar.pas"
    Parsing used unit "fpg_menu" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_menu.pas"
    Parsing used unit "fpg_form" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_form.pas"
    Parsing used unit "fpg_label" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_label.pas"
    Parsing used unit "fpg_listbox" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_listbox.pas"
    Parsing used unit "fpg_checkbox" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_checkbox.pas"
    Parsing used unit "fpg_edit" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_edit.pas"
    Parsing used unit "fpg_grid" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_grid.pas"
    Parsing used unit "fpg_customgrid" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_customgrid.pas"
    Parsing used unit "fpg_combobox" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_combobox.pas"
    Parsing used unit "fpg_panel" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_panel.pas"
    Parsing used unit "fpg_memo" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_memo.pas"
    Parsing used unit "fpg_tree" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_tree.pas"
    Parsing used unit "fpg_spinedit" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_spinedit.pas"
    Parsing used unit "fpg_tab" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_tab.pas"
    Parsing used unit "fpg_iniutils" with commandLine "-Fi../src -Fu../src/gui/ -Fu../src/corelib/ ../src/gui/fpg_iniutils.pas"
    Parsing used unit "U_Pdf" with commandLine "-Fu../src/gui/reportengine/ ../src/reportengine/u_pdf.pas"
    Ignoring unknown option "--FPDoc - Free Pascal Documentation Tool
    Version 2.6.4 [2014/10/01]
    (c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
    (c) 2005 - 2012 various FPC contributors

    exception at 080BA37F:
    [example] File not found.

     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks