USING-DEVELOPMENT-DOCUMENTATION

UPDATE-DEVELOPMENT-DOCUMENTATION




=====================================================================
USING-DEVELOPMENT-DOCUMENTATION
=====================================================================

- Development - documentation is located in ~/devel/gcad3d/src/inf/*
- Development-documentation can be shown by accessing tags
- The editor should be capable of using tagfiles.
- all tags start with INF_
- primary tag is "INF"
- access primary tag with:  "vi -t INF" (in directory ${DIR_DEV}gcad3d/src/UIX/)
- access info object-types with:  "vi -t INF_obj_types"
- access tag in vi-editor: key Ctrl-r jumps to tag under cursor; Ctrl-o returns.
- aceess tag direct - eg: vim -t INF   or vim -t DLL_dyn__
- acess direct: vi ../inf/infotext.c




- access development-documentation with ctags
cd ${DIR_DEV}gcad3d/src/APP/
./ed
- key INF or INF_obj_types  and enter



see also:
../../doc/html/dev_doc_en.htm          // Development - Documentation (how to create a plugin)



=====================================================================
UPDATE-DEVELOPMENT-DOCUMENTATION
=====================================================================

- in directory ${DIR_DEV}gcad3d/src/UIX/
- the development-documentation consists of textfiles (../inf/*.c)
- create new documentation-file eg with "vi ../inf/.c"
- each reBuild of gcad ("./do c") also recompiles all new / modified info-files 



---------------------------------------------------------------------
History Development-documentation:

  1990-2018  doxygen was used,  see ../../doc/gcad/index.htm
  since 2019 the development-documentation consists of textfiles





=====================================================================
../../doc/dev_inf_en.txt
EOF