diff mbox

[API-NEXT] doc: application-api-guide: excluding drv interface

Message ID 1471619412-25874-1-git-send-email-christophe.milard@linaro.org
State Accepted
Commit 966c1c956a21f4e70c873a3c3546e65299837457
Headers show

Commit Message

Christophe Milard Aug. 19, 2016, 3:10 p.m. UTC
The input files parsed to generate the ODP platform specific API doc
included (wrongly) part of the drv interface specification.
This led to warning on undefined symbols.
Fixed by restricting imput files to API only.

Signed-off-by: Christophe Milard <christophe.milard@linaro.org>

---
 doc/platform-api-guide/Doxyfile | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.7.4

Comments

Bill Fischofer Aug. 19, 2016, 2:18 p.m. UTC | #1
On Fri, Aug 19, 2016 at 10:10 AM, Christophe Milard <
christophe.milard@linaro.org> wrote:

> The input files parsed to generate the ODP platform specific API doc

> included (wrongly) part of the drv interface specification.

> This led to warning on undefined symbols.

> Fixed by restricting imput files to API only.

>

> Signed-off-by: Christophe Milard <christophe.milard@linaro.org>

>


Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>



> ---

>  doc/platform-api-guide/Doxyfile | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/

> Doxyfile

> index 93f6edf..fbe7c93 100644

> --- a/doc/platform-api-guide/Doxyfile

> +++ b/doc/platform-api-guide/Doxyfile

> @@ -5,9 +5,9 @@ PROJECT_NUMBER = $(VERSION)

>  PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg

>  INPUT = $(SRCDIR)/doc/application-api-guide \

>         $(SRCDIR)/doc/platform-api-guide \

> -       $(SRCDIR)/include \

> +       $(SRCDIR)/include/odp/api \

>         $(SRCDIR)/platform/$(WITH_PLATFORM)/doc \

> -       $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \

> +       $(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp/api \

>         $(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH)

>  EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR)

>  PREDEFINED = __GNUC__ \

> --

> 2.7.4

>

>
Maxim Uvarov Sept. 5, 2016, 7:11 p.m. UTC | #2
merged,
Maxim.

On 08/19/16 18:10, Christophe Milard wrote:
> The input files parsed to generate the ODP platform specific API doc

> included (wrongly) part of the drv interface specification.

> This led to warning on undefined symbols.

> Fixed by restricting imput files to API only.

>

> Signed-off-by: Christophe Milard <christophe.milard@linaro.org>

> ---

>   doc/platform-api-guide/Doxyfile | 4 ++--

>   1 file changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile

> index 93f6edf..fbe7c93 100644

> --- a/doc/platform-api-guide/Doxyfile

> +++ b/doc/platform-api-guide/Doxyfile

> @@ -5,9 +5,9 @@ PROJECT_NUMBER = $(VERSION)

>   PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg

>   INPUT = $(SRCDIR)/doc/application-api-guide \

>   	$(SRCDIR)/doc/platform-api-guide \

> -	$(SRCDIR)/include \

> +	$(SRCDIR)/include/odp/api \

>   	$(SRCDIR)/platform/$(WITH_PLATFORM)/doc \

> -	$(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \

> +	$(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp/api \

>   	$(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH)

>   EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR)

>   PREDEFINED = __GNUC__ \
diff mbox

Patch

diff --git a/doc/platform-api-guide/Doxyfile b/doc/platform-api-guide/Doxyfile
index 93f6edf..fbe7c93 100644
--- a/doc/platform-api-guide/Doxyfile
+++ b/doc/platform-api-guide/Doxyfile
@@ -5,9 +5,9 @@  PROJECT_NUMBER = $(VERSION)
 PROJECT_LOGO = $(SRCDIR)/doc/images/ODP-Logo-HQ.svg
 INPUT = $(SRCDIR)/doc/application-api-guide \
 	$(SRCDIR)/doc/platform-api-guide \
-	$(SRCDIR)/include \
+	$(SRCDIR)/include/odp/api \
 	$(SRCDIR)/platform/$(WITH_PLATFORM)/doc \
-	$(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp \
+	$(SRCDIR)/platform/$(WITH_PLATFORM)/include/odp/api \
 	$(SRCDIR)/platform/$(WITH_PLATFORM)/arch/$(WITH_ARCH)
 EXAMPLE_PATH = $(SRCDIR)/example $(SRCDIR)/platform $(SRCDIR)
 PREDEFINED = __GNUC__ \