From 65afd84db524e44f95759cf897f672aa821c9939 Mon Sep 17 00:00:00 2001 From: Magne Sjaastad Date: Tue, 4 May 2021 14:49:05 +0200 Subject: [PATCH] Documentation : Add line breaks to make sure Sphinx produce correct doc --- .../cafPdmScripting/cafPdmPythonGenerator.cpp | 14 +++++++------- GrpcInterface/Python/rips/gridcasegroup.py | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/Fwk/AppFwk/cafPdmScripting/cafPdmPythonGenerator.cpp b/Fwk/AppFwk/cafPdmScripting/cafPdmPythonGenerator.cpp index 4c27f1fd50..9a5c848bb9 100644 --- a/Fwk/AppFwk/cafPdmScripting/cafPdmPythonGenerator.cpp +++ b/Fwk/AppFwk/cafPdmScripting/cafPdmPythonGenerator.cpp @@ -151,10 +151,10 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const { if ( proxyField->hasGetter() ) { - QString fullComment = - QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" ) - .arg( comment ) - .arg( dataType ); + QString fullComment = QString( " \"\"\"%1\n\n Returns:\n " + "%2\n \"\"\"" ) + .arg( comment ) + .arg( dataType ); QString fieldCode = QString( " def %1(self):\n%2\n return " "self._call_get_method(\"%3\")\n" ) @@ -165,7 +165,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const } if ( proxyField->hasSetter() ) { - QString fullComment = QString( " \"\"\"Set %1\n Arguments:\n" + QString fullComment = QString( " \"\"\"Set %1\n\n Arguments:\n" " values (%2): data\n \"\"\"" ) .arg( comment ) .arg( dataType ); @@ -208,7 +208,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const : scriptDataType; QString fullComment = - QString( " \"\"\"%1\n Returns:\n %2\n \"\"\"" ) + QString( " \"\"\"%1\n\n Returns:\n %2\n \"\"\"" ) .arg( comment ) .arg( commentDataType ); @@ -271,7 +271,7 @@ QString PdmPythonGenerator::generate( PdmObjectFactory* factory ) const argumentComments.push_back( QString( "%1 (%2): %3" ).arg( argumentName ).arg( dataType ).arg( field->uiCapability()->uiWhatsThis() ) ); } - QString fullComment = QString( " \"\"\"\n %1\n Arguments:\n " + QString fullComment = QString( " \"\"\"\n %1\n\n Arguments:\n " "%2\n Returns:\n %3\n \"\"\"" ) .arg( methodComment ) .arg( argumentComments.join( "\n " ) ) diff --git a/GrpcInterface/Python/rips/gridcasegroup.py b/GrpcInterface/Python/rips/gridcasegroup.py index 61fac00c87..3a9edc2b56 100644 --- a/GrpcInterface/Python/rips/gridcasegroup.py +++ b/GrpcInterface/Python/rips/gridcasegroup.py @@ -55,6 +55,7 @@ def views(self): @add_method(GridCaseGroup) def view(self, view_id): """Get a particular view belonging to a case group by providing view id + Arguments: id(int): view id