1# Licensed to the Apache Software Foundation (ASF) under one
2# or more contributor license agreements.  See the NOTICE file
3# distributed with this work for additional information
4# regarding copyright ownership.  The ASF licenses this file
5# to you under the Apache License, Version 2.0 (the
6# "License"); you may not use this file except in compliance
7# with the License.  You may obtain a copy of the License at
8#
9#   http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing,
12# software distributed under the License is distributed on an
13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14# KIND, either express or implied.  See the License for the
15# specific language governing permissions and limitations
16# under the License.
17
18package AI::MXNet::NDArray::Doc;
19use strict;
20use warnings;
21use AI::MXNet::Base;
22use Exporter;
23use base qw(Exporter);
24@AI::MXNet::NDArray::Doc::EXPORT = qw(build_doc);
25
26=head2
27
28    Build docstring for imperative functions.
29=cut
30
31sub build_doc
32{
33    my ($func_name,
34        $desc,
35        $arg_names,
36        $arg_types,
37        $arg_desc,
38        $key_var_num_args,
39        $ret_type) = @_;
40    my $param_str = build_param_doc($arg_names, $arg_types, $arg_desc);
41    if($key_var_num_args)
42    {
43        $desc .= "\nThis function support variable length of positional input."
44    }
45    my $doc_str = sprintf("%s\n\n" .
46               "%s\n" .
47               "out : NDArray, optional\n" .
48               "    The output NDArray to hold the result.\n\n".
49               "Returns\n" .
50               "-------\n" .
51               "out : NDArray or list of NDArray\n" .
52               "    The output of this function.", $desc, $param_str);
53    return $doc_str
54}
55
561;
57