search

modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
466 stars 166 forks source link

Parameters' description string missing or not starting with upper case #2636

Closed tobolar closed 4 years ago

tobolar commented 6 years ago

See below for other concerned libraries.

The following components from Modelica.Blocks are affected.

christiankral commented 6 years ago

@ThomasBoedrich In #2636 I updated the documentation string of sigma in Modelica.Magnetic.FluxTubes.Material.HysteresisTableData.BaseData to:

parameter SI.Conductivity sigma = 1 "Electric conductivity";

I suppose this is OK as simply took the explanation from the HTML documentation.

christiankral commented 6 years ago

@tobolar The protected parameter arrays 

  parameter Real Ptable[:]={1E-6,1845,3549,5325,7521,9372,11010,12930,
      14950,16360,18500,18560,20180,22170};
  parameter Real Itable[:]={11.0,11.20,12.27,13.87,16.41,18.78,21.07,
      23.92,27.05,29.40,32.85,32.95,35.92,39.35};
  parameter Real ntable[:]={1500,1496,1493,1490,1486,1482,1479,1475,1471,
      1467,1462,1462,1458,1453};
  parameter Real ctable[:]={0.085,0.327,0.506,0.636,0.741,0.797,0.831,
      0.857,0.875,0.887,0.896,0.896,0.902,0.906};
  parameter Real etable[:]={0,0.7250,0.8268,0.8698,0.8929,0.9028,0.9064,
      0.9088,0.9089,0.9070,0.9044,0.9043,0.9008,0.8972};

in Modelica.Magnetic.FundamentalWave.Examples.BasicMachines.AIMC_withLosses and Modelica.Magnetic.QuasiStatic.FundamentalWave.Examples.BasicMachines.InductionMachines.IMC_withLosses are NOT included in your list; however, I do not know if this a consequence of the array type or the protected section...

tobolar commented 6 years ago

@christiankral Protected parameters are excluded in the list. But you are of course free to add the parameter decription to them.

tobolar commented 6 years ago

@kristinmajetta, @christiankral Would you also mark proceeded classes in the check list of this issue? If you mean it's too much effort (well there are really a lot of classes concerned), I would change the check list to simple bullet list.

kristinmajetta commented 6 years ago

marked the proceeded classes from Modelica.Electrical.Analog, Modelica.Electrical.Digital and Modelica.Electrical.Spice3

beutlich commented 5 years ago

@casella Can you please care for the Modelica.Fluid descriptions as stated above.

christiankral commented 5 years ago

Done from my side.

beutlich commented 5 years ago

Done from my side.

Only Fluid and Media left to do, right?

christiankral commented 5 years ago

I missed Modelica.Magnetic.FluxTubes previously; now covered by #2980.

Otherwise, Fluid, Media and Math are missing.

beutlich commented 4 years ago

@casella Reminder: Can you please update the description comments in Fluid as reported?

beutlich commented 4 years ago

@casella Reminder: Can you please update the description comments in Fluid as reported?

I did so in #3281. Please review.