РОБОДок

РОБОДок
Разработчик(и)	Франс Слотубер
Первоначальный выпуск	1994
Стабильная версия	4.99.44 / 29 января 2021 г.
Репозиторий	github .с /гумпу /РОБОДок
Написано в	С
Операционная система	Linux , Windows , Mac OS , Солярис
Тип	Генератор документации
Лицензия	Стандартная общественная лицензия GNU
Веб-сайт	Домашняя страница РОБОДока

ROBODoc — это инструмент документации, аналогичный Javadoc и лицензированный по лицензии GPL . Он используется для извлечения API документации из исходного кода . Его можно использовать с любым языком, который поддерживает комментарии и работает путем извлечения заголовков в специальном формате. Затем они переформатируются в HTML , DocBook , TROFF , ASCII , LaTeX , PDF или RTF .

Его можно использовать для документирования любого артефакта программирования, такого как классы, функции, тесты, записи make-файла и т. д.

ROBODoc работает с C , C++ , Fortran , Perl , сценариями оболочки , Assembler , DCL , DB/C , Tcl/Tk , Forth , Lisp , COBOL , Occam , Basic , HTML , Clarion и любым другим языком, поддерживающим комментарии. ^{[ нужна ссылка ]}

История

Первая версия ROBODoc была написана Жакко ван Вертом в 1995 году. ROBODoc был вдохновлен программой Autodocs, доступной на Amiga . Autodocs выдавал только выходные данные в формате ASCII . Джакко создал версию, которая создавала выходные данные в формате Amigaguide . Это позволило создать гиперссылки между различными частями документации.

Пример

Типичный заголовок ROBODoc

  /****f* Robodoc/RB_Panic [2.0d]
   * SYNOPSIS
   */
   
   void RB_Panic (char* cause, char *add_info)
   
  /*
   * FUNCTION
   *   Prints an error message.
   *   Frees all resources used by robodoc.
   *   Terminates program.
   * INPUTS
   *   * cause    - pointer to a string which describes the
   *                cause of the error.
   *   * add_info - pointer to a string with additional information.
   * SEE ALSO
   *   RB_Close_The_Shop ()
   * SOURCE
   */
    {
      printf ("Robodoc: Error, %s\n",cause) ;
      printf ("         %s\n", add_info) ;
      printf ("Robodoc: Panic Fatal error, closing down..\n") ;
      RB_Close_The_Shop () ; /* Free All Resources */
      exit(100) ;
    }
    
   /*******/