From fc9f2bb3e2ef36d123451650e141ae5038cc00fc Mon Sep 17 00:00:00 2001 From: tmanevik Date: Thu, 4 Jun 2015 14:35:27 +0200 Subject: inets: Remove documentation of legacy API --- lib/inets/doc/src/Makefile | 1 - lib/inets/doc/src/httpd_conf.xml | 163 --------------------------------------- lib/inets/doc/src/ref_man.xml | 1 - 3 files changed, 165 deletions(-) delete mode 100644 lib/inets/doc/src/httpd_conf.xml (limited to 'lib/inets') diff --git a/lib/inets/doc/src/Makefile b/lib/inets/doc/src/Makefile index a0a3472c4a..cb71fbeb9c 100644 --- a/lib/inets/doc/src/Makefile +++ b/lib/inets/doc/src/Makefile @@ -52,7 +52,6 @@ XML_REF3_FILES = \ http_uri.xml\ httpc.xml\ httpd.xml \ - httpd_conf.xml \ httpd_custom_api.xml \ httpd_socket.xml \ httpd_util.xml \ diff --git a/lib/inets/doc/src/httpd_conf.xml b/lib/inets/doc/src/httpd_conf.xml deleted file mode 100644 index 54a5885eb4..0000000000 --- a/lib/inets/doc/src/httpd_conf.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - -
- - 19972013 - Ericsson AB. All Rights Reserved. - - - Licensed 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 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - - - httpd_conf - Joakim Grebenö - - 1997-10-14 - 2.2 - httpd_conf.sgml -
- httpd_conf - Configuration utility functions to be used by the Erlang - Web server API programmer. - -

This module provides the Erlang Webserver API programmer with - utility functions for adding run-time configuration directives.

- - - - - - - check_enum(EnumString, ValidEnumStrings) -> Result - Check if string is a valid enumeration. - - EnumString = string() - ValidEnumStrings = [string()] - Result = {ok,atom()} | {error,not_valid} - - - -

check_enum/2 checks if EnumString is a valid - enumeration of ValidEnumStrings in which case it is - returned as an atom.

- - - - - - - clean(String) -> Stripped - Remove leading and/or trailing white spaces. - - String = Stripped = string() - - - -

clean/1 removes leading and/or trailing white spaces - from String.

- - - - - - - custom_clean(String,Before,After) -> Stripped - Remove leading and/or trailing white spaces and custom characters. - - Before = After = regexp() - String = Stripped = string() - - - -

custom_clean/3 removes leading and/or trailing white - spaces and custom characters from String. Before - and After are regular expressions, as defined in - regexp(3), describing the custom characters.

- - - - - - - is_directory(FilePath) -> Result - Check if a file path is a directory. - - FilePath = string() - Result = {ok,Directory} | {error,Reason} - Directory = string() - Reason = string() | enoent | eacces | enotdir | FileInfo - FileInfo = File info record - - - -

is_directory/1 checks if FilePath is a - directory in which case it is returned. Please read - file(3) for a description of enoent, - eacces and enotdir. The definition of - the file info record can be found by including file.hrl - from the kernel application, see file(3).

- - - - - - - is_file(FilePath) -> Result - Check if a file path is a regular file. - - FilePath = string() - Result = {ok,File} | {error,Reason} - File = string() - Reason = string() | enoent | eacces | enotdir | FileInfo - FileInfo = File info record - - - -

is_file/1 checks if FilePath is a regular - file in which case it is returned. Read file(3) for a - description of enoent, eacces and - enotdir. The definition of the file info record can be - found by including file.hrl from the kernel application, - see file(3).

- - - - - - - make_integer(String) -> Result - Return an integer representation of a string. - - String = string() - Result = {ok,integer()} | {error,nomatch} - - - -

make_integer/1 returns an integer representation of - String.

- - - - -
- - SEE ALSO -

httpd(3)

-
- - - - diff --git a/lib/inets/doc/src/ref_man.xml b/lib/inets/doc/src/ref_man.xml index bcebcc0fd4..ab6b399a74 100644 --- a/lib/inets/doc/src/ref_man.xml +++ b/lib/inets/doc/src/ref_man.xml @@ -39,7 +39,6 @@ - -- cgit v1.2.3