From 9d93ed7cd1b36830f6d7aedd4e6f15667774de1d Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Fri, 3 May 2013 23:19:14 +0200 Subject: API CHANGE: odk: stop packaging autodoc tool There is no need to package doxygen, users can just download that from upstream. Change-Id: I166b2f5b692d2335246e3484089ebe5d8edcae4a --- odk/Package_bin.mk | 1 - odk/Package_docs.mk | 1 - odk/docs/common/ref/idl.css | 164 -------------------------------------------- odk/docs/tools.html | 101 ++------------------------- odk/util/check.pl | 4 +- 5 files changed, 9 insertions(+), 262 deletions(-) delete mode 100644 odk/docs/common/ref/idl.css diff --git a/odk/Package_bin.mk b/odk/Package_bin.mk index 8c1200fed1b7..46d447a0e71c 100644 --- a/odk/Package_bin.mk +++ b/odk/Package_bin.mk @@ -13,7 +13,6 @@ $(eval $(call gb_Package_set_outdir,odk_bin,$(INSTDIR))) $(eval $(call gb_Package_add_files,odk_bin,$(gb_Package_SDKDIRNAME)/bin,\ $(addsuffix $(gb_Executable_EXT),\ - autodoc \ $(if $(filter WNT,$(OS)),climaker) \ cppumaker \ idlc \ diff --git a/odk/Package_docs.mk b/odk/Package_docs.mk index 24052a9f6555..515c682b1d2e 100644 --- a/odk/Package_docs.mk +++ b/odk/Package_docs.mk @@ -12,7 +12,6 @@ $(eval $(call gb_Package_Package,odk_docs,$(SRCDIR)/odk)) $(eval $(call gb_Package_set_outdir,odk_docs,$(INSTDIR))) $(eval $(call gb_Package_add_files_with_dir,odk_docs,$(gb_Package_SDKDIRNAME),\ - docs/common/ref/idl.css \ docs/images/arrow-1.gif \ docs/images/arrow-2.gif \ docs/images/arrow-3.gif \ diff --git a/odk/docs/common/ref/idl.css b/odk/docs/common/ref/idl.css deleted file mode 100644 index 0fde8562ced8..000000000000 --- a/odk/docs/common/ref/idl.css +++ /dev/null @@ -1,164 +0,0 @@ -/* Autodoc css file for IDL documentation */ -/* - * This file is part of the LibreOffice project. - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - * - * This file incorporates work covered by the following license notice: - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed - * with this work for additional information regarding copyright - * ownership. The ASF licenses this file to you under the Apache - * License, Version 2.0 (the "License"); you may not use this file - * except in compliance with the License. You may obtain a copy of - * the License at http://www.apache.org/licenses/LICENSE-2.0 . - */ - -/*See bottom of file for explanations.*/ - -body { background-color:#ffffff; } - -#adc-idlref a { color: #000000; text-decoration: none; } -#adc-idlref a:link { color: #18A303; text-decoration: none; } -#adc-idlref a:hover { text-decoration: underline; } -#adc-idlref a:visited { color: #106802; } - -#adc-idlref h3 - { font-size:13pt; font-weight:bold; - margin-top:3pt; margin-bottom:1pt; } - -#adc-idlref p, #adc-idlref dt, #adc-idlref dd, #adc-idlref pre - { font-size:11pt; - margin-top:3pt; margin-bottom:1pt; } - -#adc-idlref pre { font-family:monospace; } - -#adc-idlref table.subtitle { margin-top:6pt; margin-bottom:6pt; } - -#adc-idlref td { font-size:11pt; } -#adc-idlref td.title - { font-family: Arial; font-size:19pt; font-weight:bold; - line-height:30pt; - background-color:#18a303; - text-align:center; } - -#adc-idlref td.subtitle - { font-family: Arial; font-size:13pt; - line-height:20pt; - background-color:#18a303; } - -#adc-idlref td.crosstitle - { font-size:12pt; font-weight:bold; - line-height:15pt; background-color:#eeeeff; } - -#adc-idlref td.imdetail - { width:100%; - background-color:#c2f6ba; } - -#adc-idlref td.imsum_left { width:30%; } -#adc-idlref td.imsum_right { width:70%; } - -#adc-idlref table.navimain { background-color:#18a303; } - -#adc-idlref td.navimain - { background-color:#18a303; - text-align:center; - font-family: Arial; font-size:12pt; font-weight:bold; - padding-left:7pt; padding-right:7pt; } - -#adc-idlref td.navimainself - { text-align:center; - font-family: Arial; font-size:12pt; font-weight:bold; - color:#ffffff; background-color:#106802;} - -#adc-idlref td.navimainnone - { text-align:center; - font-family: Arial; font-size:12pt; - color:#ffffff; } - -#adc-idlref td.navisub - { text-align:center; - font-family: Arial; font-size:9pt; font-variant:small-caps; - padding-left:7pt; padding-right:7pt; } - -#adc-idlref a.navimain - { text-align:center; - font-family: Arial; font-size:12pt; font-weight:bold; - color:#C44B01; } - -#adc-idlref a.navisub - { text-align:center; - font-family: Arial; font-size:9pt; font-variant:small-caps; - color:#C44B01; } - -#adc-idlref a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; } - -#adc-idlref a:link.navisub { color:#18a303; } -#adc-idlref a:visited.navisub { color: #106802; } -#adc-idlref a:hover.navisub { color: #106802; text-decoration: underline; } - -#adc-idlref a:link.navimain { color:#ffffff; } -#adc-idlref a:visited.navimain { color: #ffffff; } -#adc-idlref a:hover.navimain { color: #ffffff; text-decoration: underline; } - -#adc-idlref .dt { font-weight:bold; } -#adc-idlref .namechain { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:6pt; } -#adc-idlref .title2 { font-size:13pt; font-style:italic; font-weight:bold; text-align:left; } - -#adc-idlref table { empty-cells:show; } - -#adc-idlref .childlist td, -#adc-idlref .commentedlinks td, -#adc-idlref .memberlist td, -#adc-idlref .subtitle td, -#adc-idlref .crosstitle td { border: .1pt solid grey; } - -#adc-idlref .flag-table td { border: .1pt solid #cccccc; } - -#adc-idlref .title-table td, -#adc-idlref .table-in-method td, -#adc-idlref .table-in-data td, -#adc-idlref .navimain td, -#adc-idlref .navisub td, -#adc-idlref .expl-table td, -#adc-idlref .param-table td { border: none; } - -#adc-idlref .devdoc td { - border-width: 1px; - padding: 5px; - border-style: inset; - border-color: gray; - background-color: white; } - -#adc-idlref .devdoc th { - border-width: 1px; - padding: 5px; - border-style: inset; - border-color: gray; - background-color: white; } - -/* Explanation of CSS classes: - -table.lightbg Background of navigation bar. -.navimain Text in main navigation bar. -.navisub Text in lower navigation bar. -td.navimainself Cell in main navigation bar with "selected" shadow: You are here. -td.navimainnone Cell in main navigation bar with no link. - -.namechain Line with current module path. - -td.crosstitle Comment box for bases (base interfaces etc.) -td.imsum_left Left part of such boxes. -td.imsum_right Right part of such boxes. - -td.title Main title of the page like "interface XYz" -.subtitle Tables, and head cells of those, which list members - like "method summary" and "method details". - -td.imdetail Background table of method's detail description. -a.membertitle Method name (as jump label) in method's detail - description. -*/ diff --git a/odk/docs/tools.html b/odk/docs/tools.html index 219e594dd879..364cb090b25a 100644 --- a/odk/docs/tools.html +++ b/odk/docs/tools.html @@ -128,12 +128,6 @@ in a human readable manner. Special support for type library nodes. - - - autodoc - Tool to generate javadoc-like documentation - for C/C++ and UNOIDL files. - @@ -923,94 +917,13 @@ types the specified types depend on.

-

The 'autodoc' tool is used for creating javadoc-like documentation - from C++ and UNOIDL source code.

-

There are some conventions to follow when documenting C++- or - UNOIDL-sourcecode. See also the UNOIDL Documentation Guidelines.
- If you are not familiar with these, but do know javadoc: For simple C++ - sourcecode documentation, using javadoc-style comments will work.

-

Usage:

-
- autodoc [ -v <VerboseNr> ] [ -name "<TitleForTheDocu>" ] -html <OutputDirectory> -lg <SourcecodeLanguage>
- { [ -p <ProjectName> <ProjectRootDirectory> ]  -t <SourceTree>* | -d <SourceDirectory>* | -f <SourceFile>* }* -
-

Options:

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-v <VerboseNr><VerboseNr> == 5 displays the parsed source - code tokens, so you can locate which piece caused an parsing error.
- <VerboseNr> == 2 displays not only the parsed source code, - but also the comments.

- This option must be the first one, if it is used.
-name "<Title>"<Title> occurs as the title of the start - page of the HTML output. If this option is omitted, a default title is - created.
-html <OutputDirectory>specifies the root directory where the HTML output - is created.
- Autodoc does not remove old files there, though it overwrites them.
-lg <SourcecodeLanguage>Possible values are: c++ | idl.

- This also specifies which files will be parsed: "c++" parses - all files with the endings .hxx and .h, "idl" parses all - files with the ending '.idl' .
- To change this behaviour, see at option -f.
-p <ProjectName> <ProjectDirectory>this option can be used to divide large code - bases into different projects.
- <ProjectName> gives a user-defined name for the project.
- <ProjectDirectory> is the root to which all paths, given with the - following options -t,-d and -f, are - relative.
- This option can be omitted when there are no projects and all paths in - the following options are relative to the working directory.

- The "{ ... }*" around the options -p,-t,-d,-f - indicates, that this whole block of options can be repeated, each block - starting with a new -p.
-t <SourceTree>specifies that all files in the directory - <SourceTree> and it's subdirectories are parsed, where the file - ending matches the option -lg.
- There can be given multiple directories after one -t - option.
- All relative paths  are relative to the project-rootdirectory, - given with the -p option.
-
-d <SourceDirectory>Specifies that all files in th directory - <SourceDirectory>, but NOT it's subdirectories, are parsed, where - the file ending matches the option -lg.
- There can be multiple directories given after one -d - option.
- All relative paths  are relative to the project-rootdirectory, - given with the -p option.
-f <SourceFile>parses the given file. The ending does not have - to match the -lg option.
- There can be multiple files given after one -f option.
- All relative paths  are relative to the project-rootdirectory, - given with the -p option.
-

Remark: The sequence of options matters! Use them in the order given - in the "Usage"-paragraph.

+

The legacy 'autodoc' tool was used for creating javadoc-like + documentation from C++ and UNO IDL source code in previous versions + of the SDK.

+

Because this tool was buggy and unmaintained it has been removed + from the SDK. Users are advised to use + Doxygen instead, + which supports UNO IDL since April 2013.

diff --git a/odk/util/check.pl b/odk/util/check.pl index 4be8536eadd4..e6a004e8f3c8 100644 --- a/odk/util/check.pl +++ b/odk/util/check.pl @@ -46,7 +46,7 @@ if (-d "$SdkDir") { print "check binaries: "; if (check_dir("bin")) { my @binarylist = ( "idlc","cppumaker","javamaker", - "regcompare","autodoc", + "regcompare", "unoapploader", "uno-skeletonmaker" ); if ($ENV{SYSTEM_UCPP} eq "") { push @binarylist,"ucpp"; @@ -96,7 +96,7 @@ if (-d "$SdkDir") { "images/nav_right.png","images/nav_up.png", "images/sdk_head-1.png", "images/sdk_head-2.png", "images/sdk_line-1.gif", "images/sdk_line-2.gif", - "common/ref/idl.css", "images/nada.gif", + "images/nada.gif", "images/arrow-2.gif", "images/bluball.gif", "images/ooo-main-app_32.png"); -- cgit v1.2.3