Moved all module docstrings to the top of the file.
This commit is contained in:
committed by
Yorik van Havre
parent
34275a2392
commit
0c9fde600a
@@ -19,10 +19,7 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
__title__="FreeCAD Arch Component"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
__doc__ = """This module provides the base Arch component class, that is shared
|
||||
"""This module provides the base Arch component class, that is shared
|
||||
by all of the Arch BIM objects.
|
||||
|
||||
Examples
|
||||
@@ -30,6 +27,10 @@ Examples
|
||||
TODO put examples here.
|
||||
"""
|
||||
|
||||
__title__="FreeCAD Arch Component"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
|
||||
import FreeCAD,Draft,ArchCommands,math,sys,json,os,ArchIFC,ArchIFCSchema
|
||||
from FreeCAD import Vector
|
||||
if FreeCAD.GuiUp:
|
||||
|
||||
@@ -21,6 +21,10 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
"""This module provides tools to build Floor objects. Floors are used
|
||||
to group different Arch objects situated at a same level.
|
||||
"""
|
||||
|
||||
import FreeCAD,Draft,ArchCommands, DraftVecUtils, ArchIFC
|
||||
if FreeCAD.GuiUp:
|
||||
import FreeCADGui
|
||||
@@ -47,9 +51,6 @@ __title__="FreeCAD Arch Floor"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
|
||||
__doc__ = """This module provides tools to build Floor objects. Floors are used
|
||||
to group different Arch objects situated at a same level.
|
||||
"""
|
||||
|
||||
|
||||
def makeFloor(objectslist=None,baseobj=None,name="Floor"):
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import FreeCAD, os, json
|
||||
|
||||
__doc__="""This modules sets up and manages the IFC-related properties, types
|
||||
"""This modules sets up and manages the IFC-related properties, types
|
||||
and attributes of Arch/BIM objects.
|
||||
"""
|
||||
|
||||
import FreeCAD, os, json
|
||||
|
||||
if FreeCAD.GuiUp:
|
||||
from PySide.QtCore import QT_TRANSLATE_NOOP
|
||||
else:
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import FreeCAD, os, json
|
||||
|
||||
__doc__ = """Provides the IFC schema data as dicts, by loading the JSON schema files.
|
||||
"""Provides the IFC schema data as dicts, by loading the JSON schema files.
|
||||
|
||||
Provides the data as IfcContexts, IfcProducts and IfcTypes.
|
||||
"""
|
||||
|
||||
import FreeCAD, os, json
|
||||
|
||||
ifcVersions = ["IFC4", "IFC2X3"]
|
||||
IfcVersion = ifcVersions[FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Arch").GetInt("IfcVersion",0)]
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
"""View providers and UI elements for the Ifc classes."""
|
||||
|
||||
import FreeCAD, ArchIFC
|
||||
|
||||
if FreeCAD.GuiUp:
|
||||
import FreeCADGui
|
||||
from PySide import QtGui
|
||||
|
||||
__doc__ = """View providers and UI elements for the Ifc classes."""
|
||||
|
||||
class IfcContextView:
|
||||
"""A default view provider for IfcContext objects."""
|
||||
|
||||
|
||||
@@ -21,6 +21,11 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
"""This module provides tools to build Project objects. Project objects are
|
||||
objects specifically for better IFC compatability, allowing the user to tweak
|
||||
certain IFC relevant values.
|
||||
"""
|
||||
|
||||
import FreeCAD,Draft,ArchComponent,ArchCommands,math,re,datetime,ArchIFC,ArchIFCView
|
||||
if FreeCAD.GuiUp:
|
||||
import FreeCADGui
|
||||
@@ -42,11 +47,6 @@ else:
|
||||
__title__="FreeCAD Project"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
__doc__ = """This module provides tools to build Project objects.
|
||||
Project objects are objects specifically for better IFC
|
||||
compatability, allowing the user to tweak certain IFC
|
||||
relevant values.
|
||||
"""
|
||||
|
||||
def makeProject(sites=None, name="Project"):
|
||||
"""Creates an Arch project.
|
||||
|
||||
@@ -21,6 +21,10 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
"""This module provides tools to build Site objects. Sites are
|
||||
containers for Arch objects, and also define a terrain surface.
|
||||
"""
|
||||
|
||||
import FreeCAD,Draft,ArchCommands,math,re,datetime,ArchIFC
|
||||
if FreeCAD.GuiUp:
|
||||
import FreeCADGui
|
||||
@@ -46,8 +50,6 @@ else:
|
||||
__title__="FreeCAD Site"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
__doc__ = """This module provides tools to build Site objects. Sites are
|
||||
containers for Arch objects, and also define a terrain surface."""
|
||||
|
||||
|
||||
def makeSite(objectslist=None,baseobj=None,name="Site"):
|
||||
|
||||
@@ -19,6 +19,16 @@
|
||||
#* *
|
||||
#***************************************************************************
|
||||
|
||||
"""This module provides tools to build Wall objects. Walls are simple
|
||||
objects, usually vertical, typically obtained by giving a thickness to a base
|
||||
line, then extruding it vertically.
|
||||
|
||||
Examples
|
||||
--------
|
||||
TODO put examples here.
|
||||
|
||||
"""
|
||||
|
||||
import FreeCAD,Draft,ArchComponent,DraftVecUtils,ArchCommands,math
|
||||
from FreeCAD import Vector
|
||||
if FreeCAD.GuiUp:
|
||||
@@ -47,16 +57,6 @@ __title__="FreeCAD Wall"
|
||||
__author__ = "Yorik van Havre"
|
||||
__url__ = "http://www.freecadweb.org"
|
||||
|
||||
__doc__="""This module provides tools to build Wall objects. Walls are simple
|
||||
objects, usually vertical, typically obtained by giving a thickness to a base
|
||||
line, then extruding it vertically.
|
||||
|
||||
Examples
|
||||
--------
|
||||
TODO put examples here.
|
||||
|
||||
"""
|
||||
|
||||
def makeWall(baseobj=None,height=None,length=None,width=None,align="Center",face=None,name="Wall"):
|
||||
"""Creates a wall based on a given object, and returns the generated wall.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user